Onconova API 1.0.0¶
Welcome to the Onconova API — a secure, standards-based interface designed to facilitate the exchange, management, and analysis of research data related to cancer genomics, clinical records, and associated metadata. This API provides an extensive set of RESTful endpoints enabling authorized users to perform full CRUD (Create, Read, Update, Delete) operations on various resources within the platform’s data ecosystem.
The primary objective of this API is to support precision oncology research by enabling interoperability between data systems, promoting data sharing among research institutions, and streamlining workflows for clinical and genomic data management in a secure, authenticated environment.
Authentication¶
To ensure the security and integrity of cancer research data, all API requests require proper authentication.
A valid session token must be obtained prior to accessing any protected
endpoint. This token must be included in the request header X-Session-Token.
The authentication and authorization flows for obtaining and managing session tokens are provided through the AllAuth authentication service. This includes endpoints for user login, logout, password management, and token renewal. For complete details on implementing authentication and managing session tokens, please refer to the AllAuth API documentation.
Important: Unauthorized requests or those missing valid authentication
tokens will receive an HTTP 401 Unauthorized response.
Terminologies¶
Many resources take objects of the type CodedConcept to represent concepts
from coded terminologies. Each property of the type CodedConcept in a schema
will have an associated x-terminology attribute. The full list of
CodedConcept objects allowed for specific resource properties can be retrieved
through the terminology
endpoint by passing the
x-terminology value as the terminologyName parameter.
Terms and Conditions¶
By accessing and using this website, you agree to comply with and be bound by the following terms and conditions. The content provided on this API is intended solely for general informational and research purposes. While we strive to ensure the information is accurate and reliable, we do not make any express or implied warranties about the accuracy, adequacy, validity, reliability, availability, or completeness of the content.
The information presented on this platform is provided in good faith. However, we do not accept any liability for any loss or damage incurred as a result of using the site or relying on the information provided. Your use of this site and any reliance on the content is solely at your own risk.
These terms and conditions may be updated from time to time, and it is your responsibility to review them regularly to ensure compliance.
License¶
The Onconova API specification is made available under the MIT License, a permissive open-source license that allows users to freely use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, subject to the inclusion of the original copyright and license.
License: MIT
Servers¶
| Description | URL |
|---|---|
| API server | https://{domain}:{port}/api |
API Health¶
GET /api/v1/healthcheck¶
Health Check
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"server": {
"const": "ok",
"description": "Whether the server is online",
"title": "Server Status",
"type": "string"
},
"database": {
"anyOf": [
{
"const": "ok",
"type": "string"
},
{
"const": "error",
"type": "string"
}
],
"description": "Whether the database is online",
"title": "Database Status"
},
"database_connection_time_ms": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Database connection time in milliseconds",
"title": "Database Connection Time"
},
"migrations": {
"anyOf": [
{
"const": "ok",
"type": "string"
},
{
"const": "pending",
"type": "string"
},
{
"const": "error",
"type": "string"
}
],
"description": "Whether there are pending migrations",
"title": "Migration Status"
}
},
"required": [
"server",
"database",
"migrations"
],
"title": "HealthCheck",
"type": "object"
}
Response 401 Unauthorized
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
Authentication¶
POST /api/v1/auth/session¶
Login
Description
Login a user using basic authorization via username/password to obtain session token and/or access token.
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
Response 401 Unauthorized
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/auth/provider/session¶
Login With Provider Token
Request body
{
"provider": "string",
"process": null,
"token": {
"client_id": "string",
"id_token": "string",
"access_token": "string"
}
}
Schema of the request body
{
"properties": {
"provider": {
"title": "Provider",
"type": "string"
},
"process": {
"anyOf": [
{
"const": "login",
"type": "string"
},
{
"const": "connect",
"type": "string"
}
],
"title": "Process"
},
"token": {
"$ref": "#/components/schemas/UserProviderClientToken"
}
},
"required": [
"provider",
"process",
"token"
],
"title": "UserProviderToken",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
Response 400 Bad Request
Response 401 Unauthorized
Response 500 Internal Server Error
Users¶
GET /api/v1/users¶
Get All Users Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
accessLevel.between |
query | array | No | Access level - Filter for entries with values between two specified values (inclusive) | |
accessLevel.equal |
query | integer | No | Access level - Filter for entries with values exactly equal to the specified value | |
accessLevel.greaterThan |
query | integer | No | Access level - Filter for entries with values greater than the specified value | |
accessLevel.greaterThanOrEqual |
query | integer | No | Access level - Filter for entries with values greater than or equal to the specified value | |
accessLevel.lessThan |
query | integer | No | Access level - Filter for entries with values less than the specified value | |
accessLevel.lessThanOrEqual |
query | integer | No | Access level - Filter for entries with values less than or equal to the specified value | |
accessLevel.not.between |
query | array | No | Access level - Filter for entries with values between two specified values (inclusive) | |
accessLevel.not.equal |
query | integer | No | Access level - Filter for entries with values not equal to the specified value | |
canExportData |
query | boolean | No | Export Data - Filter for yes/no statement | |
canManageCases |
query | boolean | No | Manage Cases - Filter for yes/no statement | |
canManageProjects |
query | boolean | No | Manage Projects - Filter for yes/no statement | |
canManageUsers |
query | boolean | No | Manage Users - Filter for yes/no statement | |
canViewCases |
query | boolean | No | View Cases - Filter for yes/no statement | |
canViewCohorts |
query | boolean | No | View Cohorts - Filter for yes/no statement | |
canViewDatasets |
query | boolean | No | View Datasets - Filter for yes/no statement | |
canViewProjects |
query | boolean | No | View Projects - Filter for yes/no statement | |
canViewUsers |
query | boolean | No | View Users - Filter for yes/no statement | |
department |
query | string | No | Department - Filter for full text matches | |
department.anyOf |
query | array | No | Department - Filter for entries where at least one reference matches the query | |
department.beginsWith |
query | string | No | Department - Filter for entries starting with the text | |
department.contains |
query | string | No | Department - Filter for partial text matches | |
department.endsWith |
query | string | No | Department - Filter for entries ending with the text | |
department.exists |
query | boolean | No | Department - Filter for entries with a value | |
department.not |
query | string | No | Department - Filter for full text mismatches | |
department.not.anyOf |
query | array | No | Department - Filter for entries where at least one reference mismatches the query | |
department.not.beginsWith |
query | string | No | Department - Filter for entries not starting with the text | |
department.not.contains |
query | string | No | Department - Filter for partial text mismatches | |
department.not.endsWith |
query | string | No | Department - Filter for entries not ending with the text | |
department.not.exists |
query | boolean | No | Department - Filter for entries without a value | |
email |
query | string | No | Email Address - Filter for full text matches | |
email.anyOf |
query | array | No | Email Address - Filter for entries where at least one reference matches the query | |
email.beginsWith |
query | string | No | Email Address - Filter for entries starting with the text | |
email.contains |
query | string | No | Email Address - Filter for partial text matches | |
email.endsWith |
query | string | No | Email Address - Filter for entries ending with the text | |
email.exists |
query | boolean | No | Email Address - Filter for entries with a value | |
email.not |
query | string | No | Email Address - Filter for full text mismatches | |
email.not.anyOf |
query | array | No | Email Address - Filter for entries where at least one reference mismatches the query | |
email.not.beginsWith |
query | string | No | Email Address - Filter for entries not starting with the text | |
email.not.contains |
query | string | No | Email Address - Filter for partial text mismatches | |
email.not.endsWith |
query | string | No | Email Address - Filter for entries not ending with the text | |
email.not.exists |
query | boolean | No | Email Address - Filter for entries without a value | |
firstName |
query | string | No | First Name - Filter for full text matches | |
firstName.anyOf |
query | array | No | First Name - Filter for entries where at least one reference matches the query | |
firstName.beginsWith |
query | string | No | First Name - Filter for entries starting with the text | |
firstName.contains |
query | string | No | First Name - Filter for partial text matches | |
firstName.endsWith |
query | string | No | First Name - Filter for entries ending with the text | |
firstName.exists |
query | boolean | No | First Name - Filter for entries with a value | |
firstName.not |
query | string | No | First Name - Filter for full text mismatches | |
firstName.not.anyOf |
query | array | No | First Name - Filter for entries where at least one reference mismatches the query | |
firstName.not.beginsWith |
query | string | No | First Name - Filter for entries not starting with the text | |
firstName.not.contains |
query | string | No | First Name - Filter for partial text mismatches | |
firstName.not.endsWith |
query | string | No | First Name - Filter for entries not ending with the text | |
firstName.not.exists |
query | boolean | No | First Name - Filter for entries without a value | |
fullName |
query | string | No | Full Name - Filter for full text matches | |
fullName.anyOf |
query | array | No | Full Name - Filter for entries where at least one reference matches the query | |
fullName.beginsWith |
query | string | No | Full Name - Filter for entries starting with the text | |
fullName.contains |
query | string | No | Full Name - Filter for partial text matches | |
fullName.endsWith |
query | string | No | Full Name - Filter for entries ending with the text | |
fullName.not |
query | string | No | Full Name - Filter for full text mismatches | |
fullName.not.anyOf |
query | array | No | Full Name - Filter for entries where at least one reference mismatches the query | |
fullName.not.beginsWith |
query | string | No | Full Name - Filter for entries not starting with the text | |
fullName.not.contains |
query | string | No | Full Name - Filter for partial text mismatches | |
fullName.not.endsWith |
query | string | No | Full Name - Filter for entries not ending with the text | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
isActive |
query | boolean | No | Active - Filter for yes/no statement | |
isProvided |
query | boolean | No | Is Provided - Filter for yes/no statement | |
isServiceAccount |
query | boolean | No | Is service account? - Filter for yes/no statement | |
isSystemAdmin |
query | boolean | No | System Administrator - Filter for yes/no statement | |
lastLogin.after |
query | string | No | Last Login - Filter for entries with dates after the specified value | |
lastLogin.before |
query | string | No | Last Login - Filter for entries with dates before the specified value | |
lastLogin.between |
query | array | No | Last Login - Filter for entries with dates between two specified values (inclusive) | |
lastLogin.exists |
query | boolean | No | Last Login - Filter for entries with a value | |
lastLogin.not.between |
query | array | No | Last Login - Filter for entries with dates not between two specified values (inclusive) | |
lastLogin.not.exists |
query | boolean | No | Last Login - Filter for entries without a value | |
lastLogin.not.on |
query | string | No | Last Login - Filter for entries with dates not matching the specified value | |
lastLogin.on |
query | string | No | Last Login - Filter for entries with dates exactly matching the specified value | |
lastLogin.onOrAfter |
query | string | No | Last Login - Filter for entries with dates on or after the specified value | |
lastLogin.onOrBefore |
query | string | No | Last Login - Filter for entries with dates on or before the specified value | |
lastName |
query | string | No | Last Name - Filter for full text matches | |
lastName.anyOf |
query | array | No | Last Name - Filter for entries where at least one reference matches the query | |
lastName.beginsWith |
query | string | No | Last Name - Filter for entries starting with the text | |
lastName.contains |
query | string | No | Last Name - Filter for partial text matches | |
lastName.endsWith |
query | string | No | Last Name - Filter for entries ending with the text | |
lastName.exists |
query | boolean | No | Last Name - Filter for entries with a value | |
lastName.not |
query | string | No | Last Name - Filter for full text mismatches | |
lastName.not.anyOf |
query | array | No | Last Name - Filter for entries where at least one reference mismatches the query | |
lastName.not.beginsWith |
query | string | No | Last Name - Filter for entries not starting with the text | |
lastName.not.contains |
query | string | No | Last Name - Filter for partial text mismatches | |
lastName.not.endsWith |
query | string | No | Last Name - Filter for entries not ending with the text | |
lastName.not.exists |
query | boolean | No | Last Name - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
organization |
query | string | No | Organization - Filter for full text matches | |
organization.anyOf |
query | array | No | Organization - Filter for entries where at least one reference matches the query | |
organization.beginsWith |
query | string | No | Organization - Filter for entries starting with the text | |
organization.contains |
query | string | No | Organization - Filter for partial text matches | |
organization.endsWith |
query | string | No | Organization - Filter for entries ending with the text | |
organization.exists |
query | boolean | No | Organization - Filter for entries with a value | |
organization.not |
query | string | No | Organization - Filter for full text mismatches | |
organization.not.anyOf |
query | array | No | Organization - Filter for entries where at least one reference mismatches the query | |
organization.not.beginsWith |
query | string | No | Organization - Filter for entries not starting with the text | |
organization.not.contains |
query | string | No | Organization - Filter for partial text mismatches | |
organization.not.endsWith |
query | string | No | Organization - Filter for entries not ending with the text | |
organization.not.exists |
query | boolean | No | Organization - Filter for entries without a value | |
provider |
query | string | No | Provider - Filter for full text matches | |
provider.anyOf |
query | array | No | Provider - Filter for entries where at least one reference matches the query | |
provider.beginsWith |
query | string | No | Provider - Filter for entries starting with the text | |
provider.contains |
query | string | No | Provider - Filter for partial text matches | |
provider.endsWith |
query | string | No | Provider - Filter for entries ending with the text | |
provider.exists |
query | boolean | No | Provider - Filter for entries with a value | |
provider.not |
query | string | No | Provider - Filter for full text mismatches | |
provider.not.anyOf |
query | array | No | Provider - Filter for entries where at least one reference mismatches the query | |
provider.not.beginsWith |
query | string | No | Provider - Filter for entries not starting with the text | |
provider.not.contains |
query | string | No | Provider - Filter for partial text mismatches | |
provider.not.endsWith |
query | string | No | Provider - Filter for entries not ending with the text | |
provider.not.exists |
query | boolean | No | Provider - Filter for entries without a value | |
role |
query | None | No | Role - Filter for single value choice | |
role.anyOf |
query | array | No | Role - ('Filter for excluding a subset of value choices',) | |
role.not |
query | None | No | Role - ('Filter for all but a single value choice',) | |
shareable |
query | boolean | No | Shareable - Filter for yes/no statement | |
shareable.exists |
query | boolean | No | Shareable - Filter for entries with a value | |
shareable.not.exists |
query | boolean | No | Shareable - Filter for entries without a value | |
title |
query | string | No | Title - Filter for full text matches | |
title.anyOf |
query | array | No | Title - Filter for entries where at least one reference matches the query | |
title.beginsWith |
query | string | No | Title - Filter for entries starting with the text | |
title.contains |
query | string | No | Title - Filter for partial text matches | |
title.endsWith |
query | string | No | Title - Filter for entries ending with the text | |
title.exists |
query | boolean | No | Title - Filter for entries with a value | |
title.not |
query | string | No | Title - Filter for full text mismatches | |
title.not.anyOf |
query | array | No | Title - Filter for entries where at least one reference mismatches the query | |
title.not.beginsWith |
query | string | No | Title - Filter for entries not starting with the text | |
title.not.contains |
query | string | No | Title - Filter for partial text mismatches | |
title.not.endsWith |
query | string | No | Title - Filter for entries not ending with the text | |
title.not.exists |
query | boolean | No | Title - Filter for entries without a value | |
username |
query | string | No | Username - Filter for full text matches | |
username.anyOf |
query | array | No | Username - Filter for entries where at least one reference matches the query | |
username.beginsWith |
query | string | No | Username - Filter for entries starting with the text | |
username.contains |
query | string | No | Username - Filter for partial text matches | |
username.endsWith |
query | string | No | Username - Filter for entries ending with the text | |
username.not |
query | string | No | Username - Filter for full text mismatches | |
username.not.anyOf |
query | array | No | Username - Filter for entries where at least one reference mismatches the query | |
username.not.beginsWith |
query | string | No | Username - Filter for entries not starting with the text | |
username.not.contains |
query | string | No | Username - Filter for partial text mismatches | |
username.not.endsWith |
query | string | No | Username - Filter for entries not ending with the text |
Response 200 OK
{
"count": 0,
"items": [
{
"fullName": "string",
"role": "External",
"canViewCases": true,
"canViewProjects": true,
"canViewCohorts": true,
"canViewUsers": true,
"canViewDatasets": true,
"canManageCases": true,
"canExportData": true,
"canManageProjects": true,
"canManageUsers": true,
"isSystemAdmin": true,
"isProvided": true,
"provider": "string",
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"id": "093d5978-91a0-4af4-b7a9-f7d489ed7c1e",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/users¶
Create User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true
}
Schema of the request body
{
"description": "Schema for creating a new user.",
"properties": {
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string",
"x-expanded": false
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string",
"x-expanded": false
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string",
"x-expanded": false
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string",
"x-expanded": false
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string",
"x-expanded": false
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean",
"x-expanded": false
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean",
"x-expanded": false
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string",
"x-expanded": false
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string",
"x-expanded": false
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string",
"x-expanded": false
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer",
"x-expanded": false
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean",
"x-expanded": false
}
},
"required": [
"username"
],
"title": "UserCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/users/{userId}¶
Get User By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
userId |
path | string | No |
Response 200 OK
{
"fullName": "string",
"role": "External",
"canViewCases": true,
"canViewProjects": true,
"canViewCohorts": true,
"canViewUsers": true,
"canViewDatasets": true,
"canManageCases": true,
"canExportData": true,
"canManageProjects": true,
"canManageUsers": true,
"isSystemAdmin": true,
"isProvided": true,
"provider": "string",
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"id": "3826c912-54b5-423c-ab0e-8f40cbb762c1",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true
}
Schema of the response body
{
"description": "Detailed schema for User data retrieval.",
"properties": {
"fullName": {
"description": "The user's full name.",
"title": "Full Name",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/AccessRoles",
"description": "The user's assigned access role.",
"title": "Role"
},
"canViewCases": {
"description": "Permission to view cases.",
"title": "View Cases",
"type": "boolean"
},
"canViewProjects": {
"description": "Permission to view projects.",
"title": "View Projects",
"type": "boolean"
},
"canViewCohorts": {
"description": "Permission to view cohorts.",
"title": "View Cohorts",
"type": "boolean"
},
"canViewUsers": {
"description": "Permission to view other user accounts.",
"title": "View Users",
"type": "boolean"
},
"canViewDatasets": {
"description": "Permission to view available datasets.",
"title": "View Datasets",
"type": "boolean"
},
"canManageCases": {
"description": "Permission to manage cases.",
"title": "Manage Cases",
"type": "boolean"
},
"canExportData": {
"description": "Permission to export data out of the system.",
"title": "Export Data",
"type": "boolean"
},
"canManageProjects": {
"description": "Permission to manage projects.",
"title": "Manage Projects",
"type": "boolean"
},
"canManageUsers": {
"description": "Permission to create and manage users.",
"title": "Manage Users",
"type": "boolean"
},
"isSystemAdmin": {
"description": "Whether the user is a system administrator.",
"title": "System Administrator",
"type": "boolean"
},
"isProvided": {
"description": "Indicates whether the user account is externally provided.",
"title": "Is Provided",
"type": "boolean"
},
"provider": {
"description": "The external authentication provider, if applicable.",
"title": "Provider",
"type": "string"
},
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string",
"x-expanded": false
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string",
"x-expanded": false
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string",
"x-expanded": false
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string",
"x-expanded": false
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string",
"x-expanded": false
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean",
"x-expanded": false
},
"id": {
"description": "",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean",
"x-expanded": false
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string",
"x-expanded": false
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string",
"x-expanded": false
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string",
"x-expanded": false
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer",
"x-expanded": false
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean",
"x-expanded": false
}
},
"required": [
"fullName",
"role",
"canViewCases",
"canViewProjects",
"canViewCohorts",
"canViewUsers",
"canViewDatasets",
"canManageCases",
"canExportData",
"canManageProjects",
"canManageUsers",
"isSystemAdmin",
"isProvided",
"username",
"id"
],
"title": "User",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/users/{userId}¶
Update User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
userId |
path | string | No |
Request body
{
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true
}
Schema of the request body
{
"description": "Schema for creating a new user.",
"properties": {
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string",
"x-expanded": false
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string",
"x-expanded": false
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string",
"x-expanded": false
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string",
"x-expanded": false
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string",
"x-expanded": false
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean",
"x-expanded": false
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean",
"x-expanded": false
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string",
"x-expanded": false
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string",
"x-expanded": false
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string",
"x-expanded": false
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer",
"x-expanded": false
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean",
"x-expanded": false
}
},
"required": [
"username"
],
"title": "UserCreate",
"type": "object"
}
Response 200 OK
{
"fullName": "string",
"role": "External",
"canViewCases": true,
"canViewProjects": true,
"canViewCohorts": true,
"canViewUsers": true,
"canViewDatasets": true,
"canManageCases": true,
"canExportData": true,
"canManageProjects": true,
"canManageUsers": true,
"isSystemAdmin": true,
"isProvided": true,
"provider": "string",
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"id": "0653a712-df3f-48a0-878b-4cf43e84e989",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true
}
Schema of the response body
{
"description": "Detailed schema for User data retrieval.",
"properties": {
"fullName": {
"description": "The user's full name.",
"title": "Full Name",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/AccessRoles",
"description": "The user's assigned access role.",
"title": "Role"
},
"canViewCases": {
"description": "Permission to view cases.",
"title": "View Cases",
"type": "boolean"
},
"canViewProjects": {
"description": "Permission to view projects.",
"title": "View Projects",
"type": "boolean"
},
"canViewCohorts": {
"description": "Permission to view cohorts.",
"title": "View Cohorts",
"type": "boolean"
},
"canViewUsers": {
"description": "Permission to view other user accounts.",
"title": "View Users",
"type": "boolean"
},
"canViewDatasets": {
"description": "Permission to view available datasets.",
"title": "View Datasets",
"type": "boolean"
},
"canManageCases": {
"description": "Permission to manage cases.",
"title": "Manage Cases",
"type": "boolean"
},
"canExportData": {
"description": "Permission to export data out of the system.",
"title": "Export Data",
"type": "boolean"
},
"canManageProjects": {
"description": "Permission to manage projects.",
"title": "Manage Projects",
"type": "boolean"
},
"canManageUsers": {
"description": "Permission to create and manage users.",
"title": "Manage Users",
"type": "boolean"
},
"isSystemAdmin": {
"description": "Whether the user is a system administrator.",
"title": "System Administrator",
"type": "boolean"
},
"isProvided": {
"description": "Indicates whether the user account is externally provided.",
"title": "Is Provided",
"type": "boolean"
},
"provider": {
"description": "The external authentication provider, if applicable.",
"title": "Provider",
"type": "string"
},
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string",
"x-expanded": false
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string",
"x-expanded": false
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string",
"x-expanded": false
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string",
"x-expanded": false
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string",
"x-expanded": false
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean",
"x-expanded": false
},
"id": {
"description": "",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean",
"x-expanded": false
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string",
"x-expanded": false
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string",
"x-expanded": false
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string",
"x-expanded": false
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer",
"x-expanded": false
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean",
"x-expanded": false
}
},
"required": [
"fullName",
"role",
"canViewCases",
"canViewProjects",
"canViewCohorts",
"canViewUsers",
"canViewDatasets",
"canManageCases",
"canExportData",
"canManageProjects",
"canManageUsers",
"isSystemAdmin",
"isProvided",
"username",
"id"
],
"title": "User",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/users/{userId}/profile¶
Update User Profile
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
userId |
path | string | No |
Request body
{
"firstName": "string",
"lastName": "string",
"organization": "string",
"department": "string",
"title": "string",
"email": "string"
}
Schema of the request body
{
"description": "Schema for user profile data.",
"properties": {
"firstName": {
"description": "The user's given name.",
"title": "First Name",
"type": "string"
},
"lastName": {
"description": "The user's surname.",
"title": "Last Name",
"type": "string"
},
"organization": {
"description": "The user's affiliated organization.",
"title": "Organization",
"type": "string"
},
"department": {
"description": "The user's department within the organization.",
"title": "Department",
"type": "string"
},
"title": {
"description": "The user's job title or position.",
"title": "Job Title",
"type": "string"
},
"email": {
"description": "The user's primary email address.",
"title": "Email Address",
"type": "string"
}
},
"required": [
"firstName",
"lastName",
"email"
],
"title": "UserProfileSchema",
"type": "object"
}
Response 201 Created
{
"fullName": "string",
"role": "External",
"canViewCases": true,
"canViewProjects": true,
"canViewCohorts": true,
"canViewUsers": true,
"canViewDatasets": true,
"canManageCases": true,
"canExportData": true,
"canManageProjects": true,
"canManageUsers": true,
"isSystemAdmin": true,
"isProvided": true,
"provider": "string",
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"id": "635a83f7-7023-48d9-b711-2d3c47f5cc4a",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true
}
Schema of the response body
{
"description": "Detailed schema for User data retrieval.",
"properties": {
"fullName": {
"description": "The user's full name.",
"title": "Full Name",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/AccessRoles",
"description": "The user's assigned access role.",
"title": "Role"
},
"canViewCases": {
"description": "Permission to view cases.",
"title": "View Cases",
"type": "boolean"
},
"canViewProjects": {
"description": "Permission to view projects.",
"title": "View Projects",
"type": "boolean"
},
"canViewCohorts": {
"description": "Permission to view cohorts.",
"title": "View Cohorts",
"type": "boolean"
},
"canViewUsers": {
"description": "Permission to view other user accounts.",
"title": "View Users",
"type": "boolean"
},
"canViewDatasets": {
"description": "Permission to view available datasets.",
"title": "View Datasets",
"type": "boolean"
},
"canManageCases": {
"description": "Permission to manage cases.",
"title": "Manage Cases",
"type": "boolean"
},
"canExportData": {
"description": "Permission to export data out of the system.",
"title": "Export Data",
"type": "boolean"
},
"canManageProjects": {
"description": "Permission to manage projects.",
"title": "Manage Projects",
"type": "boolean"
},
"canManageUsers": {
"description": "Permission to create and manage users.",
"title": "Manage Users",
"type": "boolean"
},
"isSystemAdmin": {
"description": "Whether the user is a system administrator.",
"title": "System Administrator",
"type": "boolean"
},
"isProvided": {
"description": "Indicates whether the user account is externally provided.",
"title": "Is Provided",
"type": "boolean"
},
"provider": {
"description": "The external authentication provider, if applicable.",
"title": "Provider",
"type": "string"
},
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string",
"x-expanded": false
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string",
"x-expanded": false
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string",
"x-expanded": false
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string",
"x-expanded": false
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string",
"x-expanded": false
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean",
"x-expanded": false
},
"id": {
"description": "",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean",
"x-expanded": false
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string",
"x-expanded": false
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string",
"x-expanded": false
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string",
"x-expanded": false
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer",
"x-expanded": false
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean",
"x-expanded": false
}
},
"required": [
"fullName",
"role",
"canViewCases",
"canViewProjects",
"canViewCohorts",
"canViewUsers",
"canViewDatasets",
"canManageCases",
"canExportData",
"canManageProjects",
"canManageUsers",
"isSystemAdmin",
"isProvided",
"username",
"id"
],
"title": "User",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/users/{userId}/password¶
Update User Password
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
userId |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"description": "Schema for user password reset payload.",
"properties": {
"oldPassword": {
"description": "The user's current password.",
"title": "Old Password",
"type": "string"
},
"newPassword": {
"description": "The user's new password to be set.",
"title": "New Password",
"type": "string"
}
},
"required": [
"oldPassword",
"newPassword"
],
"title": "UserPasswordReset",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/users/{userId}/password/reset¶
Reset User Password
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
password |
query | string | No | ||
userId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/users/{userId}/events¶
Get User Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
userId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Projects¶
GET /api/v1/projects¶
Get All Projects Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
clinicalCenters |
query | string | No | Clinical Centers - Filter for full text matches | |
clinicalCenters.anyOf |
query | array | No | Clinical Centers - Filter for entries where at least one reference matches the query | |
clinicalCenters.beginsWith |
query | string | No | Clinical Centers - Filter for entries starting with the text | |
clinicalCenters.contains |
query | string | No | Clinical Centers - Filter for partial text matches | |
clinicalCenters.endsWith |
query | string | No | Clinical Centers - Filter for entries ending with the text | |
clinicalCenters.not |
query | string | No | Clinical Centers - Filter for full text mismatches | |
clinicalCenters.not.anyOf |
query | array | No | Clinical Centers - Filter for entries where at least one reference mismatches the query | |
clinicalCenters.not.beginsWith |
query | string | No | Clinical Centers - Filter for entries not starting with the text | |
clinicalCenters.not.contains |
query | string | No | Clinical Centers - Filter for partial text mismatches | |
clinicalCenters.not.endsWith |
query | string | No | Clinical Centers - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
ethicsApprovalNumber |
query | string | No | Ethics approval number - Filter for full text matches | |
ethicsApprovalNumber.anyOf |
query | array | No | Ethics approval number - Filter for entries where at least one reference matches the query | |
ethicsApprovalNumber.beginsWith |
query | string | No | Ethics approval number - Filter for entries starting with the text | |
ethicsApprovalNumber.contains |
query | string | No | Ethics approval number - Filter for partial text matches | |
ethicsApprovalNumber.endsWith |
query | string | No | Ethics approval number - Filter for entries ending with the text | |
ethicsApprovalNumber.not |
query | string | No | Ethics approval number - Filter for full text mismatches | |
ethicsApprovalNumber.not.anyOf |
query | array | No | Ethics approval number - Filter for entries where at least one reference mismatches the query | |
ethicsApprovalNumber.not.beginsWith |
query | string | No | Ethics approval number - Filter for entries not starting with the text | |
ethicsApprovalNumber.not.contains |
query | string | No | Ethics approval number - Filter for partial text mismatches | |
ethicsApprovalNumber.not.endsWith |
query | string | No | Ethics approval number - Filter for entries not ending with the text | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
leader.username |
query | string | No | Project leader - Filter for username matches | |
leader.username.anyOf |
query | array | No | Project leader - Filter for entries where at least one reference mismatches the query | |
leader.username.not |
query | string | No | Project leader - Filter for username mismatches | |
leader.username.not.anyOf |
query | string | No | Project leader - Filter for entries where at least one reference matches the query | |
limit |
query | integer | 10 | No | |
members.username |
query | string | No | Project members - Filter for username matches | |
members.username.anyOf |
query | array | No | Project members - Filter for entries where at least one reference mismatches the query | |
members.username.not |
query | string | No | Project members - Filter for username mismatches | |
members.username.not.anyOf |
query | string | No | Project members - Filter for entries where at least one reference matches the query | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
status |
query | None | No | Project status - Filter for single value choice | |
status.anyOf |
query | array | No | Project status - ('Filter for excluding a subset of value choices',) | |
status.not |
query | None | No | Project status - ('Filter for all but a single value choice',) | |
summary |
query | string | No | Project description - Filter for full text matches | |
summary.anyOf |
query | array | No | Project description - Filter for entries where at least one reference matches the query | |
summary.beginsWith |
query | string | No | Project description - Filter for entries starting with the text | |
summary.contains |
query | string | No | Project description - Filter for partial text matches | |
summary.endsWith |
query | string | No | Project description - Filter for entries ending with the text | |
summary.not |
query | string | No | Project description - Filter for full text mismatches | |
summary.not.anyOf |
query | array | No | Project description - Filter for entries where at least one reference mismatches the query | |
summary.not.beginsWith |
query | string | No | Project description - Filter for entries not starting with the text | |
summary.not.contains |
query | string | No | Project description - Filter for partial text mismatches | |
summary.not.endsWith |
query | string | No | Project description - Filter for entries not ending with the text | |
title |
query | string | No | Project title - Filter for full text matches | |
title.anyOf |
query | array | No | Project title - Filter for entries where at least one reference matches the query | |
title.beginsWith |
query | string | No | Project title - Filter for entries starting with the text | |
title.contains |
query | string | No | Project title - Filter for partial text matches | |
title.endsWith |
query | string | No | Project title - Filter for entries ending with the text | |
title.not |
query | string | No | Project title - Filter for full text mismatches | |
title.not.anyOf |
query | array | No | Project title - Filter for entries where at least one reference mismatches the query | |
title.not.beginsWith |
query | string | No | Project title - Filter for entries not starting with the text | |
title.not.contains |
query | string | No | Project title - Filter for partial text mismatches | |
title.not.endsWith |
query | string | No | Project title - Filter for entries not ending with the text | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"id": "f738328b-c6fa-448e-9041-8299e57b22de",
"externalSource": "string",
"externalSourceId": "string",
"leader": "string",
"clinicalCenters": [
"string"
],
"title": "string",
"summary": "string",
"ethicsApprovalNumber": "string",
"status": null,
"dataConstraints": {},
"members": [
"string"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/projects¶
Create Project
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"leader": "string",
"clinicalCenters": [
"string"
],
"title": "string",
"summary": "string",
"ethicsApprovalNumber": "string",
"status": null,
"dataConstraints": {},
"members": [
"string"
]
}
Schema of the request body
{
"description": "Schema for creating a new research project record.",
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"leader": {
"description": "User responsible for the project and its members",
"title": "Project leader",
"type": "string",
"x-expanded": false
},
"clinicalCenters": {
"description": "Clinical centers that are part of the project",
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Clinical Centers",
"type": "array",
"x-expanded": false
},
"title": {
"description": "Title of the project",
"maxLength": 200,
"title": "Project title",
"type": "string",
"x-expanded": false
},
"summary": {
"description": "Description of the project",
"title": "Project description",
"type": "string",
"x-expanded": false
},
"ethicsApprovalNumber": {
"description": "Ethics approval number of the project",
"maxLength": 100,
"title": "Ethics approval number",
"type": "string",
"x-expanded": false
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectStatusChoices",
"maxLength": 20
}
],
"default": "planned",
"description": "Status of the project",
"title": "Project status",
"x-expanded": false
},
"dataConstraints": {
"description": "Data constraints of the project",
"title": "Data constraints",
"type": "object",
"x-expanded": false
},
"members": {
"description": "Users that are part of the project",
"items": {
"type": "string"
},
"title": "Project members",
"type": "array",
"x-expanded": false
}
},
"required": [
"leader",
"clinicalCenters",
"title",
"summary",
"ethicsApprovalNumber"
],
"title": "ProjectCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/projects/{projectId}¶
Get Project By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
projectId |
path | string | No |
Response 200 OK
{
"id": "deee885e-9c9d-4129-9f90-99f740f116de",
"externalSource": "string",
"externalSourceId": "string",
"leader": "string",
"clinicalCenters": [
"string"
],
"title": "string",
"summary": "string",
"ethicsApprovalNumber": "string",
"status": null,
"dataConstraints": {},
"members": [
"string"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"description": "Schema for retrieving a research project record.",
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"leader": {
"description": "User responsible for the project and its members",
"title": "Project leader",
"type": "string",
"x-expanded": false
},
"clinicalCenters": {
"description": "Clinical centers that are part of the project",
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Clinical Centers",
"type": "array",
"x-expanded": false
},
"title": {
"description": "Title of the project",
"maxLength": 200,
"title": "Project title",
"type": "string",
"x-expanded": false
},
"summary": {
"description": "Description of the project",
"title": "Project description",
"type": "string",
"x-expanded": false
},
"ethicsApprovalNumber": {
"description": "Ethics approval number of the project",
"maxLength": 100,
"title": "Ethics approval number",
"type": "string",
"x-expanded": false
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectStatusChoices",
"maxLength": 20
}
],
"default": "planned",
"description": "Status of the project",
"title": "Project status",
"x-expanded": false
},
"dataConstraints": {
"description": "Data constraints of the project",
"title": "Data constraints",
"type": "object",
"x-expanded": false
},
"members": {
"description": "Users that are part of the project",
"items": {
"type": "string"
},
"title": "Project members",
"type": "array",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"leader",
"clinicalCenters",
"title",
"summary",
"ethicsApprovalNumber",
"description"
],
"title": "Project",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/projects/{projectId}¶
Update Project
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
projectId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"leader": "string",
"clinicalCenters": [
"string"
],
"title": "string",
"summary": "string",
"ethicsApprovalNumber": "string",
"status": null,
"dataConstraints": {},
"members": [
"string"
]
}
Schema of the request body
{
"description": "Schema for creating a new research project record.",
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"leader": {
"description": "User responsible for the project and its members",
"title": "Project leader",
"type": "string",
"x-expanded": false
},
"clinicalCenters": {
"description": "Clinical centers that are part of the project",
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Clinical Centers",
"type": "array",
"x-expanded": false
},
"title": {
"description": "Title of the project",
"maxLength": 200,
"title": "Project title",
"type": "string",
"x-expanded": false
},
"summary": {
"description": "Description of the project",
"title": "Project description",
"type": "string",
"x-expanded": false
},
"ethicsApprovalNumber": {
"description": "Ethics approval number of the project",
"maxLength": 100,
"title": "Ethics approval number",
"type": "string",
"x-expanded": false
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectStatusChoices",
"maxLength": 20
}
],
"default": "planned",
"description": "Status of the project",
"title": "Project status",
"x-expanded": false
},
"dataConstraints": {
"description": "Data constraints of the project",
"title": "Data constraints",
"type": "object",
"x-expanded": false
},
"members": {
"description": "Users that are part of the project",
"items": {
"type": "string"
},
"title": "Project members",
"type": "array",
"x-expanded": false
}
},
"required": [
"leader",
"clinicalCenters",
"title",
"summary",
"ethicsApprovalNumber"
],
"title": "ProjectCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/projects/{projectId}¶
Delete Project
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
projectId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/projects/{projectId}/history/events¶
Get All Project History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
projectId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/projects/{projectId}/history/events/{eventId}¶
Get Project History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
projectId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/projects/{projectId}/history/events/{eventId}/reversion¶
Revert Project To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
projectId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants¶
Get All Project Data Manager Grant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
memberId |
path | string | No | ||
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
projectId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"isValid": true,
"id": "ca1f390d-4117-4cb0-b6d4-fc304d70ad8c",
"externalSource": "string",
"externalSourceId": "string",
"member": "string",
"projectId": "202d6d1c-ead8-49fa-be43-573e71bf76e0",
"revoked": true,
"validityPeriod": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Schema of the response body
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/projects/{projectId}/members/{memberId}/data-management/grants¶
Create Project Data Manager Grant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
memberId |
path | string | No | ||
projectId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"revoked": true,
"validityPeriod": {
"start": "2022-04-13",
"end": "2022-04-13"
}
}
Schema of the request body
{
"description": "Schema for creating a new project data manager grant record.\nExcludes project and member fields, as those are usually set by the system.",
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"revoked": {
"default": false,
"description": "A flag that indicated whether the authorization has been revoked",
"title": "Revoked",
"type": "boolean",
"x-expanded": false
},
"validityPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Period of validity",
"title": "Validity period",
"x-expanded": false
}
},
"required": [
"validityPeriod"
],
"title": "ProjectDataManagerGrantCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}¶
Check Project Data Manager Grant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
grantId |
path | string | No | ||
memberId |
path | string | No | ||
projectId |
path | string | No |
Response 200 OK
{
"isValid": true,
"id": "98030c62-b53f-445d-8762-5eef6491af64",
"externalSource": "string",
"externalSourceId": "string",
"member": "string",
"projectId": "b3d4813a-3315-4169-b91d-0f35e295bf7c",
"revoked": true,
"validityPeriod": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"description": "Schema for retrieving a project data manager grant record.\nIncludes additional computed properties.",
"properties": {
"isValid": {
"description": "Whether the authorization grant is valid today",
"title": "Is valid",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"member": {
"description": "Manager of the project data",
"title": "Manager",
"type": "string",
"x-expanded": false
},
"projectId": {
"description": "Project under which the permission is granted",
"format": "uuid",
"title": "Project",
"type": "string",
"x-expanded": false
},
"revoked": {
"default": false,
"description": "A flag that indicated whether the authorization has been revoked",
"title": "Revoked",
"type": "boolean",
"x-expanded": false
},
"validityPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Period of validity",
"title": "Validity period",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"isValid",
"id",
"member",
"projectId",
"validityPeriod",
"description"
],
"title": "ProjectDataManagerGrant",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}¶
Revoke Project Data Manager Grant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
grantId |
path | string | No | ||
memberId |
path | string | No | ||
projectId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events¶
Get All Project Data Management Grant History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
grantId |
path | string | No | ||
limit |
query | integer | 10 | No | |
memberId |
path | string | No | ||
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
projectId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events/{eventId}¶
Get Project Data Management Grant History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
grantId |
path | string | No | ||
memberId |
path | string | No | ||
projectId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events/{eventId}/reversion¶
Revert Project Data Management Grant To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
grantId |
path | string | No | ||
memberId |
path | string | No | ||
projectId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Interoperability¶
GET /api/v1/interoperability/resources/{resourceId}¶
Export Resource
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
resourceId |
path | string | No |
Response 200 OK
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/interoperability/resources/{resourceId}/description¶
Resolve Resource Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
resourceId |
path | string | No |
Response 200 OK
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/interoperability/bundles/{caseId}¶
Export Case Bundle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"age": null,
"dateOfBirth": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"id": "d884c777-d434-4b8b-9547-c3b8ed0ae594",
"externalSource": "string",
"externalSourceId": "string",
"pseudoidentifier": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"neoplasticEntities": [
{
"anonymized": true,
"topographyGroup": null,
"id": "f0a32fb9-fd19-4586-8787-1c9e52eacc6e",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "42217b24-b05e-4aa7-999f-4c8dbc5d7372",
"relationship": "primary",
"relatedPrimaryId": "8426add9-d5e2-4502-9468-7bf62a3d7ddf",
"assertionDate": "2022-04-13",
"topography": null,
"morphology": null,
"differentitation": null,
"laterality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"stagings": [
null
],
"tumorMarkers": [
{
"anonymized": true,
"id": "584caa03-0bd7-4a8a-807f-178c772f6e59",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f07ffe6e-bb86-4ed6-8e77-fd8f60a61332",
"date": "2022-04-13",
"analyte": null,
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"0aa51392-b57c-48be-bf66-21ef0b719b04"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"riskAssessments": [
{
"anonymized": true,
"id": "267a7ea0-4be5-4082-ad57-bf41f9fe8907",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ec2dd91c-08ae-4c55-a52c-9607359937e6",
"date": "2022-04-13",
"methodology": null,
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"84376a19-dbd8-4812-8112-b6d1216f143b"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"therapyLines": [
{
"anonymized": true,
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12,
"id": "3c3742e9-b7a0-4e70-88aa-79c07bc62211",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0d1279ec-716d-4ebc-8fe1-b8bfe7ba6fd7",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"systemicTherapies": [
{
"anonymized": true,
"medications": [
{
"id": "c85d8000-661f-4d5a-bfd6-10890558d767",
"externalSource": "string",
"externalSourceId": "string",
"drug": null,
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"duration": {
"value": 10.12,
"unit": "string"
},
"id": "f949927f-7cf1-4865-920c-cebd3c5c199d",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ab2645a0-d892-4c16-82b9-27b6eea678c2",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"isAdjunctive": true,
"terminationReason": null,
"therapyLineId": "09c6a33b-6b33-4c6a-8b40-649d28341450",
"targetedEntitiesIds": [
"ce1d1147-4fed-4128-b235-fbc6a63e1af8"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"surgeries": [
{
"anonymized": true,
"id": "fb98b3b7-a251-4146-be73-59ae12f35012",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "7c021d1a-4129-49a6-ac4a-21fb5676bb42",
"date": "2022-04-13",
"procedure": null,
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "991c34fc-c557-41f4-8d18-627a7d70630c",
"targetedEntitiesIds": [
"9dd5b66e-5407-4978-b3ee-9aae7ad375c3"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"radiotherapies": [
{
"anonymized": true,
"duration": null,
"dosages": [
{
"id": "18304e56-0f79-4e26-8b8f-0767f7b3c0da",
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": null,
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"settings": [
{
"id": "0ca2da7b-8688-4b25-9d82-135b774af279",
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "f8c05288-9959-4865-babb-c87c9027fff6",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ec1549e1-a7c1-4750-b97d-a380a1a0eca3",
"period": null,
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "16bb7aff-71c6-4be9-ac2c-de78a0e4e65e",
"targetedEntitiesIds": [
"3ca38f3b-047c-476a-ac62-c6bdac1a1df6"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"adverseEvents": [
{
"anonymized": true,
"suspectedCauses": [
{
"id": "d915fa37-8517-40be-b397-9eed1c156cf9",
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "47106a33-32df-4e1a-921f-bf95d3626f78",
"medicationId": "7fd82ad3-4dab-4939-aa34-eec76dda9e68",
"radiotherapyId": "8038f45f-5eae-4a8c-a6e7-097105bb1317",
"surgeryId": "86877b6d-2a82-4eaf-aeb0-709e77537e3f",
"causality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"mitigations": [
{
"id": "f9a8896d-55bd-4665-a3e5-7f9e931dc132",
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "fc33ca54-7919-430e-aea1-408497f87db2",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "1512566e-6ae4-406c-a3a6-aa35ad767086",
"date": "2022-04-13",
"event": null,
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"treatmentResponses": [
{
"anonymized": true,
"id": "14ddda9f-c449-4afd-bc02-69ba12275c67",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5a194126-4b6c-4c83-ab5e-d0a49d64c9ab",
"date": "2022-04-13",
"recist": null,
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"41583875-89b0-47c0-8837-4c2951671da2"
],
"assessedBodysites": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"performanceStatus": [
{
"anonymized": true,
"ecogInterpretation": null,
"karnofskyInterpretation": null,
"id": "bdb272c2-2c93-4a17-8c2e-9a80aec08f1a",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "38968ac2-4dd0-4ee0-9e61-f6ee7124d99b",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"comorbidities": [
{
"anonymized": true,
"score": null,
"id": "a7bfa67b-d041-4ae7-876c-a5689c33d451",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c57504e0-608e-4e00-ad9b-61009594d247",
"date": "2022-04-13",
"indexConditionId": "73e39242-c7a3-4423-8be4-1dba28cffe15",
"panel": null,
"presentConditions": null,
"absentConditions": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"genomicVariants": [
{
"anonymized": true,
"isPathogenic": true,
"isVUS": true,
"dnaHgvs": "string",
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaHgvs": "string",
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinHgvs": "string",
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
],
"id": "930072e4-1b60-45b8-b88e-f8f47a4fc2de",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "df9ccb50-e937-42ce-b45d-a8d98c3dc3ce",
"date": "2022-04-13",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"genes": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"genomicSignatures": [
null
],
"vitals": [
{
"anonymized": true,
"bodyMassIndex": null,
"id": "92c69189-aab0-4c89-a16a-4f226cea1ad4",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "69c53b16-91de-42e4-879d-c13141a171c9",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"lifestyles": [
{
"anonymized": true,
"id": "eb8e0e16-e6ee-45fc-b847-2a00a5930b6d",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "7779e751-c08b-4358-b4d2-ce19404ad046",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": null,
"exposures": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"familyHistory": [
{
"anonymized": true,
"id": "bf6f2e7a-2a9f-4e67-8597-fa052d3e2280",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5cb35a92-b8ee-4110-82c4-cb1a2a544660",
"date": "2022-04-13",
"relationship": null,
"hadCancer": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tumorBoards": [
null
],
"completedDataCategories": {},
"history": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"description": "The order of the properties matters for the import tool (based on references tree)",
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years",
"title": "Age"
},
"dateOfBirth": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"const": "*************",
"type": "string"
}
],
"description": "Date of birth of the patient",
"title": "Date of birth"
},
"overallSurvival": {
"description": "Overall survival of the patient since diagnosis",
"title": "Overall survival",
"type": "number"
},
"ageAtDiagnosis": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years at the time of the initial diagnosis",
"title": "Age at diagnosis"
},
"dataCompletionRate": {
"description": "Percentage indicating the completeness of a case in terms of its data.",
"title": "Data completion rate",
"type": "number"
},
"contributors": {
"description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
"items": {
"type": "string"
},
"title": "Data contributors",
"type": "array"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"pseudoidentifier": {
"description": "Pseudoidentifier of the patient",
"maxLength": 40,
"title": "Pseudoidentifier",
"type": "string",
"x-expanded": false
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string",
"x-expanded": false
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string",
"x-expanded": false
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status",
"x-expanded": false
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-expanded": false,
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-expanded": false,
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-expanded": false,
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-expanded": false,
"x-terminology": "GenderIdentity"
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status",
"x-expanded": false
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string",
"x-expanded": false
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-expanded": false,
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"neoplasticEntities": {
"default": [],
"items": {
"$ref": "#/components/schemas/NeoplasticEntity"
},
"title": "Neoplasticentities",
"type": "array"
},
"stagings": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TNMStaging"
},
{
"$ref": "#/components/schemas/FIGOStaging"
},
{
"$ref": "#/components/schemas/BinetStaging"
},
{
"$ref": "#/components/schemas/RaiStaging"
},
{
"$ref": "#/components/schemas/BreslowDepth"
},
{
"$ref": "#/components/schemas/ClarkStaging"
},
{
"$ref": "#/components/schemas/ISSStaging"
},
{
"$ref": "#/components/schemas/RISSStaging"
},
{
"$ref": "#/components/schemas/GleasonGrade"
},
{
"$ref": "#/components/schemas/INSSStage"
},
{
"$ref": "#/components/schemas/INRGSSStage"
},
{
"$ref": "#/components/schemas/WilmsStage"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
},
{
"$ref": "#/components/schemas/LymphomaStaging"
}
]
},
"title": "Stagings",
"type": "array"
},
"tumorMarkers": {
"default": [],
"items": {
"$ref": "#/components/schemas/TumorMarker"
},
"title": "Tumormarkers",
"type": "array"
},
"riskAssessments": {
"default": [],
"items": {
"$ref": "#/components/schemas/RiskAssessment"
},
"title": "Riskassessments",
"type": "array"
},
"therapyLines": {
"default": [],
"items": {
"$ref": "#/components/schemas/TherapyLine"
},
"title": "Therapylines",
"type": "array"
},
"systemicTherapies": {
"default": [],
"items": {
"$ref": "#/components/schemas/SystemicTherapy"
},
"title": "Systemictherapies",
"type": "array"
},
"surgeries": {
"default": [],
"items": {
"$ref": "#/components/schemas/Surgery"
},
"title": "Surgeries",
"type": "array"
},
"radiotherapies": {
"default": [],
"items": {
"$ref": "#/components/schemas/Radiotherapy"
},
"title": "Radiotherapies",
"type": "array"
},
"adverseEvents": {
"default": [],
"items": {
"$ref": "#/components/schemas/AdverseEvent"
},
"title": "Adverseevents",
"type": "array"
},
"treatmentResponses": {
"default": [],
"items": {
"$ref": "#/components/schemas/TreatmentResponse"
},
"title": "Treatmentresponses",
"type": "array"
},
"performanceStatus": {
"default": [],
"items": {
"$ref": "#/components/schemas/PerformanceStatus"
},
"title": "Performancestatus",
"type": "array"
},
"comorbidities": {
"default": [],
"items": {
"$ref": "#/components/schemas/ComorbiditiesAssessment"
},
"title": "Comorbidities",
"type": "array"
},
"genomicVariants": {
"default": [],
"items": {
"$ref": "#/components/schemas/GenomicVariant"
},
"title": "Genomicvariants",
"type": "array"
},
"genomicSignatures": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TumorMutationalBurden"
},
{
"$ref": "#/components/schemas/MicrosatelliteInstability"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosity"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiency"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurden"
},
{
"$ref": "#/components/schemas/AneuploidScore"
}
]
},
"title": "Genomicsignatures",
"type": "array"
},
"vitals": {
"default": [],
"items": {
"$ref": "#/components/schemas/Vitals"
},
"title": "Vitals",
"type": "array"
},
"lifestyles": {
"default": [],
"items": {
"$ref": "#/components/schemas/Lifestyle"
},
"title": "Lifestyles",
"type": "array"
},
"familyHistory": {
"default": [],
"items": {
"$ref": "#/components/schemas/FamilyHistory"
},
"title": "Familyhistory",
"type": "array"
},
"tumorBoards": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnspecifiedTumorBoard"
},
{
"$ref": "#/components/schemas/MolecularTumorBoard"
}
]
},
"title": "Tumorboards",
"type": "array"
},
"completedDataCategories": {
"additionalProperties": {
"$ref": "#/components/schemas/PatientCaseDataCompletionStatusSchema"
},
"propertyNames": {
"$ref": "#/components/schemas/PatientCaseDataCategories"
},
"title": "Completeddatacategories",
"type": "object"
},
"history": {
"default": [],
"items": {
"$ref": "#/components/schemas/HistoryEvent"
},
"title": "History",
"type": "array"
}
},
"required": [
"age",
"dateOfBirth",
"dataCompletionRate",
"contributors",
"id",
"pseudoidentifier",
"clinicalCenter",
"clinicalIdentifier",
"gender",
"description",
"completedDataCategories"
],
"title": "PatientCaseBundle",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/interoperability/bundles¶
Import Case Bundle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
conflict |
query | None | No |
Request body
{
"anonymized": true,
"age": null,
"dateOfBirth": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"id": "a56abd7c-891d-470c-b9e9-64f39b35edbe",
"externalSource": "string",
"externalSourceId": "string",
"pseudoidentifier": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"neoplasticEntities": [
{
"anonymized": true,
"topographyGroup": null,
"id": "73428cd0-482f-43a5-8ad3-49ef5d4e38ae",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "85a0dab4-116a-40a3-9137-acb66ea13c57",
"relationship": "primary",
"relatedPrimaryId": "47e8921d-ee94-4c11-8f36-b7ab1e00bd37",
"assertionDate": "2022-04-13",
"topography": null,
"morphology": null,
"differentitation": null,
"laterality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"stagings": [
null
],
"tumorMarkers": [
{
"anonymized": true,
"id": "ff33a2e1-f3b7-4cc0-a1a1-d38740919ace",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d6a779da-971f-47da-adc7-76970b28cae8",
"date": "2022-04-13",
"analyte": null,
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"13bd7a12-7090-4dfe-98db-dce4a518e8c5"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"riskAssessments": [
{
"anonymized": true,
"id": "93da9ce6-0d61-47f8-aebe-d2a98a6efc55",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "764ec059-329e-4f6c-85ff-7e2673ed3a64",
"date": "2022-04-13",
"methodology": null,
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"e28fd508-abf1-4577-8a4e-4f3099e573dc"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"therapyLines": [
{
"anonymized": true,
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12,
"id": "0a6fa4c8-ba18-47bb-988f-44e4288f8f3c",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "bc3029d2-b169-4e63-b495-1ffddae8dcf6",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"systemicTherapies": [
{
"anonymized": true,
"medications": [
{
"id": "5ac11d64-b750-4534-b9df-e70088c9e481",
"externalSource": "string",
"externalSourceId": "string",
"drug": null,
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"duration": {
"value": 10.12,
"unit": "string"
},
"id": "4c0fac08-4f42-47eb-9515-1c281d3a1fc4",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2f228994-222d-4ca7-80ef-d930ea2040f4",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"isAdjunctive": true,
"terminationReason": null,
"therapyLineId": "472f3f28-c0c5-4881-8773-82f1b221aa3d",
"targetedEntitiesIds": [
"03c330ad-c00e-4dbc-8428-1717c1906032"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"surgeries": [
{
"anonymized": true,
"id": "b8db2470-bd4c-4e2c-a481-740085cfa85b",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "15d8ffce-4087-4317-9022-98cbed4acd90",
"date": "2022-04-13",
"procedure": null,
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "0ef2ecb5-cfb4-4f34-8ed6-b7eb08f4b558",
"targetedEntitiesIds": [
"039dab20-fa54-44d4-8af4-c63f6080fc3c"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"radiotherapies": [
{
"anonymized": true,
"duration": null,
"dosages": [
{
"id": "aeb62fd5-fa3a-42ce-8061-91790e42a4ee",
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": null,
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"settings": [
{
"id": "2afd4fa7-8c81-4427-8edb-c1a14514a62a",
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "4123949d-607b-4507-b0fe-2f92d9162cc2",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "66cb2daf-23e8-4980-a150-91916999cc29",
"period": null,
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "5d55e403-13ca-4909-85f1-8e8e6bf784ce",
"targetedEntitiesIds": [
"045301d4-3130-4556-b5fc-00a3bf0d98e8"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"adverseEvents": [
{
"anonymized": true,
"suspectedCauses": [
{
"id": "aa96984d-4837-4076-984a-09b6a9fcb8f9",
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "dd0a959c-bffa-4368-86f8-1756bb19ef48",
"medicationId": "7600ca89-301f-4618-b267-302bbc8b1d7c",
"radiotherapyId": "a5b942f3-a17b-47e2-ba2c-32805bf397f1",
"surgeryId": "571ced75-9824-4f5d-9035-625b200c491c",
"causality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"mitigations": [
{
"id": "69a301d0-2fc1-469f-aff8-4485f8e6f87a",
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "ad650600-bc74-4ece-aac5-8cfb4e8e1123",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d50617d4-56b0-4449-aff4-891a04cc7936",
"date": "2022-04-13",
"event": null,
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"treatmentResponses": [
{
"anonymized": true,
"id": "3c4f3e2f-4426-4461-bec6-d597efeee664",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a316ab12-5c72-4d9a-94c4-7fac7a478b0a",
"date": "2022-04-13",
"recist": null,
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"1210d194-b7fd-422e-8761-a87243e95bc7"
],
"assessedBodysites": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"performanceStatus": [
{
"anonymized": true,
"ecogInterpretation": null,
"karnofskyInterpretation": null,
"id": "8e7d38b0-af35-405d-b089-daf163d3f36f",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "615da792-ab18-4667-918e-fb21cd8f706b",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"comorbidities": [
{
"anonymized": true,
"score": null,
"id": "b2521512-fb62-4ffc-bc11-bcfea3f73467",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9c7be6e5-fa58-478d-9aba-53bc2fc110a5",
"date": "2022-04-13",
"indexConditionId": "09663150-9dac-4dbd-a5f2-a66e89100b06",
"panel": null,
"presentConditions": null,
"absentConditions": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"genomicVariants": [
{
"anonymized": true,
"isPathogenic": true,
"isVUS": true,
"dnaHgvs": "string",
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaHgvs": "string",
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinHgvs": "string",
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
],
"id": "8c903510-3096-4ddd-9ac6-ccd6dbf9c6aa",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d27eb778-e003-41be-810c-870d166a97b1",
"date": "2022-04-13",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"genes": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"genomicSignatures": [
null
],
"vitals": [
{
"anonymized": true,
"bodyMassIndex": null,
"id": "85760662-3f14-49d0-9865-c0f6c6506d84",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d3914767-36ca-4cab-b2c7-4725a6c0a830",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"lifestyles": [
{
"anonymized": true,
"id": "4b28b511-b43e-4763-b92a-10ff7f7f56fa",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0925a62a-3eb3-4d8e-a9ab-35286aee87a7",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": null,
"exposures": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"familyHistory": [
{
"anonymized": true,
"id": "55db12d3-99ba-4237-a43a-c8ba13fa1ea3",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fa72a50b-fc35-4d67-a1ab-c6a90f0c1961",
"date": "2022-04-13",
"relationship": null,
"hadCancer": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tumorBoards": [
null
],
"completedDataCategories": {},
"history": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the request body
{
"description": "The order of the properties matters for the import tool (based on references tree)",
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years",
"title": "Age"
},
"dateOfBirth": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"const": "*************",
"type": "string"
}
],
"description": "Date of birth of the patient",
"title": "Date of birth"
},
"overallSurvival": {
"description": "Overall survival of the patient since diagnosis",
"title": "Overall survival",
"type": "number"
},
"ageAtDiagnosis": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years at the time of the initial diagnosis",
"title": "Age at diagnosis"
},
"dataCompletionRate": {
"description": "Percentage indicating the completeness of a case in terms of its data.",
"title": "Data completion rate",
"type": "number"
},
"contributors": {
"description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
"items": {
"type": "string"
},
"title": "Data contributors",
"type": "array"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"pseudoidentifier": {
"description": "Pseudoidentifier of the patient",
"maxLength": 40,
"title": "Pseudoidentifier",
"type": "string",
"x-expanded": false
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string",
"x-expanded": false
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string",
"x-expanded": false
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status",
"x-expanded": false
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-expanded": false,
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-expanded": false,
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-expanded": false,
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-expanded": false,
"x-terminology": "GenderIdentity"
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status",
"x-expanded": false
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string",
"x-expanded": false
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-expanded": false,
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"neoplasticEntities": {
"default": [],
"items": {
"$ref": "#/components/schemas/NeoplasticEntity"
},
"title": "Neoplasticentities",
"type": "array"
},
"stagings": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TNMStaging"
},
{
"$ref": "#/components/schemas/FIGOStaging"
},
{
"$ref": "#/components/schemas/BinetStaging"
},
{
"$ref": "#/components/schemas/RaiStaging"
},
{
"$ref": "#/components/schemas/BreslowDepth"
},
{
"$ref": "#/components/schemas/ClarkStaging"
},
{
"$ref": "#/components/schemas/ISSStaging"
},
{
"$ref": "#/components/schemas/RISSStaging"
},
{
"$ref": "#/components/schemas/GleasonGrade"
},
{
"$ref": "#/components/schemas/INSSStage"
},
{
"$ref": "#/components/schemas/INRGSSStage"
},
{
"$ref": "#/components/schemas/WilmsStage"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
},
{
"$ref": "#/components/schemas/LymphomaStaging"
}
]
},
"title": "Stagings",
"type": "array"
},
"tumorMarkers": {
"default": [],
"items": {
"$ref": "#/components/schemas/TumorMarker"
},
"title": "Tumormarkers",
"type": "array"
},
"riskAssessments": {
"default": [],
"items": {
"$ref": "#/components/schemas/RiskAssessment"
},
"title": "Riskassessments",
"type": "array"
},
"therapyLines": {
"default": [],
"items": {
"$ref": "#/components/schemas/TherapyLine"
},
"title": "Therapylines",
"type": "array"
},
"systemicTherapies": {
"default": [],
"items": {
"$ref": "#/components/schemas/SystemicTherapy"
},
"title": "Systemictherapies",
"type": "array"
},
"surgeries": {
"default": [],
"items": {
"$ref": "#/components/schemas/Surgery"
},
"title": "Surgeries",
"type": "array"
},
"radiotherapies": {
"default": [],
"items": {
"$ref": "#/components/schemas/Radiotherapy"
},
"title": "Radiotherapies",
"type": "array"
},
"adverseEvents": {
"default": [],
"items": {
"$ref": "#/components/schemas/AdverseEvent"
},
"title": "Adverseevents",
"type": "array"
},
"treatmentResponses": {
"default": [],
"items": {
"$ref": "#/components/schemas/TreatmentResponse"
},
"title": "Treatmentresponses",
"type": "array"
},
"performanceStatus": {
"default": [],
"items": {
"$ref": "#/components/schemas/PerformanceStatus"
},
"title": "Performancestatus",
"type": "array"
},
"comorbidities": {
"default": [],
"items": {
"$ref": "#/components/schemas/ComorbiditiesAssessment"
},
"title": "Comorbidities",
"type": "array"
},
"genomicVariants": {
"default": [],
"items": {
"$ref": "#/components/schemas/GenomicVariant"
},
"title": "Genomicvariants",
"type": "array"
},
"genomicSignatures": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TumorMutationalBurden"
},
{
"$ref": "#/components/schemas/MicrosatelliteInstability"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosity"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiency"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurden"
},
{
"$ref": "#/components/schemas/AneuploidScore"
}
]
},
"title": "Genomicsignatures",
"type": "array"
},
"vitals": {
"default": [],
"items": {
"$ref": "#/components/schemas/Vitals"
},
"title": "Vitals",
"type": "array"
},
"lifestyles": {
"default": [],
"items": {
"$ref": "#/components/schemas/Lifestyle"
},
"title": "Lifestyles",
"type": "array"
},
"familyHistory": {
"default": [],
"items": {
"$ref": "#/components/schemas/FamilyHistory"
},
"title": "Familyhistory",
"type": "array"
},
"tumorBoards": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnspecifiedTumorBoard"
},
{
"$ref": "#/components/schemas/MolecularTumorBoard"
}
]
},
"title": "Tumorboards",
"type": "array"
},
"completedDataCategories": {
"additionalProperties": {
"$ref": "#/components/schemas/PatientCaseDataCompletionStatusSchema"
},
"propertyNames": {
"$ref": "#/components/schemas/PatientCaseDataCategories"
},
"title": "Completeddatacategories",
"type": "object"
},
"history": {
"default": [],
"items": {
"$ref": "#/components/schemas/HistoryEvent"
},
"title": "History",
"type": "array"
}
},
"required": [
"age",
"dateOfBirth",
"dataCompletionRate",
"contributors",
"id",
"pseudoidentifier",
"clinicalCenter",
"clinicalIdentifier",
"gender",
"description",
"completedDataCategories"
],
"title": "PatientCaseBundle",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 422 Unprocessable Entity
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Patient Cases¶
GET /api/v1/patient-cases¶
Get All Patient Cases Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
age.between |
query | array | No | Age - Filter for entries with values between two specified values (inclusive) | |
age.equal |
query | integer | No | Age - Filter for entries with values exactly equal to the specified value | |
age.greaterThan |
query | integer | No | Age - Filter for entries with values greater than the specified value | |
age.greaterThanOrEqual |
query | integer | No | Age - Filter for entries with values greater than or equal to the specified value | |
age.lessThan |
query | integer | No | Age - Filter for entries with values less than the specified value | |
age.lessThanOrEqual |
query | integer | No | Age - Filter for entries with values less than or equal to the specified value | |
age.not.between |
query | array | No | Age - Filter for entries with values between two specified values (inclusive) | |
age.not.equal |
query | integer | No | Age - Filter for entries with values not equal to the specified value | |
ageAtDiagnosis.between |
query | array | No | Age at diagnosis - Filter for entries with values between two specified values (inclusive) | |
ageAtDiagnosis.equal |
query | integer | No | Age at diagnosis - Filter for entries with values exactly equal to the specified value | |
ageAtDiagnosis.exists |
query | boolean | No | Age at diagnosis - Filter for entries with a value | |
ageAtDiagnosis.greaterThan |
query | integer | No | Age at diagnosis - Filter for entries with values greater than the specified value | |
ageAtDiagnosis.greaterThanOrEqual |
query | integer | No | Age at diagnosis - Filter for entries with values greater than or equal to the specified value | |
ageAtDiagnosis.lessThan |
query | integer | No | Age at diagnosis - Filter for entries with values less than the specified value | |
ageAtDiagnosis.lessThanOrEqual |
query | integer | No | Age at diagnosis - Filter for entries with values less than or equal to the specified value | |
ageAtDiagnosis.not.between |
query | array | No | Age at diagnosis - Filter for entries with values between two specified values (inclusive) | |
ageAtDiagnosis.not.equal |
query | integer | No | Age at diagnosis - Filter for entries with values not equal to the specified value | |
ageAtDiagnosis.not.exists |
query | boolean | No | Age at diagnosis - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
causeOfDeath |
query | string | No | Cause of death - Filter for a matching concept code | |
causeOfDeath.anyOf |
query | array | No | Cause of death - Filter for a matching set of concept codes | |
causeOfDeath.descendantsOf |
query | string | No | Cause of death - Filter for all child concepts of a given concepts code | |
causeOfDeath.exists |
query | boolean | No | Cause of death - Filter for entries with a value | |
causeOfDeath.not |
query | string | No | Cause of death - Filter for a mismatching concept code | |
causeOfDeath.not.anyOf |
query | array | No | Cause of death - Filter for a mismmatching set of concept codes | |
causeOfDeath.not.exists |
query | boolean | No | Cause of death - Filter for entries without a value | |
consentStatus |
query | None | No | Consent status - Filter for single value choice | |
consentStatus.anyOf |
query | array | No | Consent status - ('Filter for excluding a subset of value choices',) | |
consentStatus.not |
query | None | No | Consent status - ('Filter for all but a single value choice',) | |
contributors |
query | array | No | Data contributors - Filter for exact array matches | |
contributors.containedBy |
query | array | No | Data contributors - Filter for entries where where the data is a subset of the values passed | |
contributors.contains |
query | array | No | Data contributors - Filter for entries where where the values passed are a subset of the data | |
contributors.not |
query | array | No | Data contributors - Filter for exact array mismatches | |
contributors.not.containedBy |
query | array | No | Data contributors - Filter for entries where the data is not a subset of the values passed | |
contributors.not.contains |
query | array | No | Data contributors - Filter for entries where the values passed are not a subset of the data | |
contributors.not.overlaps |
query | array | No | Data contributors - Filter for entries where the data shares not any results with the values passed. | |
contributors.overlaps |
query | array | No | Data contributors - Filter for entries where the data shares any results with the values passed. | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
dataCompletionRate.between |
query | array | No | Data completion rate - Filter for entries with values between two specified values (inclusive) | |
dataCompletionRate.equal |
query | number | No | Data completion rate - Filter for entries with values exactly equal to the specified value | |
dataCompletionRate.greaterThan |
query | number | No | Data completion rate - Filter for entries with values greater than the specified value | |
dataCompletionRate.greaterThanOrEqual |
query | number | No | Data completion rate - Filter for entries with values greater than or equal to the specified value | |
dataCompletionRate.lessThan |
query | number | No | Data completion rate - Filter for entries with values less than the specified value | |
dataCompletionRate.lessThanOrEqual |
query | number | No | Data completion rate - Filter for entries with values less than or equal to the specified value | |
dataCompletionRate.not.between |
query | array | No | Data completion rate - Filter for entries with values between two specified values (inclusive) | |
dataCompletionRate.not.equal |
query | number | No | Data completion rate - Filter for entries with values not equal to the specified value | |
endOfRecords.after |
query | string | No | End of records - Filter for entries with dates after the specified value | |
endOfRecords.before |
query | string | No | End of records - Filter for entries with dates before the specified value | |
endOfRecords.between |
query | array | No | End of records - Filter for entries with dates between two specified values (inclusive) | |
endOfRecords.exists |
query | boolean | No | End of records - Filter for entries with a value | |
endOfRecords.not.between |
query | array | No | End of records - Filter for entries with dates not between two specified values (inclusive) | |
endOfRecords.not.exists |
query | boolean | No | End of records - Filter for entries without a value | |
endOfRecords.not.on |
query | string | No | End of records - Filter for entries with dates not matching the specified value | |
endOfRecords.on |
query | string | No | End of records - Filter for entries with dates exactly matching the specified value | |
endOfRecords.onOrAfter |
query | string | No | End of records - Filter for entries with dates on or after the specified value | |
endOfRecords.onOrBefore |
query | string | No | End of records - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
gender |
query | string | No | Gender - Filter for a matching concept code | |
gender.anyOf |
query | array | No | Gender - Filter for a matching set of concept codes | |
gender.descendantsOf |
query | string | No | Gender - Filter for all child concepts of a given concepts code | |
gender.not |
query | string | No | Gender - Filter for a mismatching concept code | |
gender.not.anyOf |
query | array | No | Gender - Filter for a mismmatching set of concept codes | |
genderIdentity |
query | string | No | Gender identity - Filter for a matching concept code | |
genderIdentity.anyOf |
query | array | No | Gender identity - Filter for a matching set of concept codes | |
genderIdentity.descendantsOf |
query | string | No | Gender identity - Filter for all child concepts of a given concepts code | |
genderIdentity.exists |
query | boolean | No | Gender identity - Filter for entries with a value | |
genderIdentity.not |
query | string | No | Gender identity - Filter for a mismatching concept code | |
genderIdentity.not.anyOf |
query | array | No | Gender identity - Filter for a mismmatching set of concept codes | |
genderIdentity.not.exists |
query | boolean | No | Gender identity - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
idSearch |
query | None | No | ||
limit |
query | integer | 10 | No | |
morphology |
query | string | No | Morphology - Filters for matching primary morphology code. | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
overallSurvival.between |
query | array | No | Overall survival - Filter for entries with values between two specified values (inclusive) | |
overallSurvival.equal |
query | number | No | Overall survival - Filter for entries with values exactly equal to the specified value | |
overallSurvival.exists |
query | boolean | No | Overall survival - Filter for entries with a value | |
overallSurvival.greaterThan |
query | number | No | Overall survival - Filter for entries with values greater than the specified value | |
overallSurvival.greaterThanOrEqual |
query | number | No | Overall survival - Filter for entries with values greater than or equal to the specified value | |
overallSurvival.lessThan |
query | number | No | Overall survival - Filter for entries with values less than the specified value | |
overallSurvival.lessThanOrEqual |
query | number | No | Overall survival - Filter for entries with values less than or equal to the specified value | |
overallSurvival.not.between |
query | array | No | Overall survival - Filter for entries with values between two specified values (inclusive) | |
overallSurvival.not.equal |
query | number | No | Overall survival - Filter for entries with values not equal to the specified value | |
overallSurvival.not.exists |
query | boolean | No | Overall survival - Filter for entries without a value | |
primarySite |
query | string | No | Primary site - Filters for matching primary topography code. | |
pseudoidentifier |
query | string | No | Pseudoidentifier - Filter for full text matches | |
pseudoidentifier.anyOf |
query | array | No | Pseudoidentifier - Filter for entries where at least one reference matches the query | |
pseudoidentifier.beginsWith |
query | string | No | Pseudoidentifier - Filter for entries starting with the text | |
pseudoidentifier.contains |
query | string | No | Pseudoidentifier - Filter for partial text matches | |
pseudoidentifier.endsWith |
query | string | No | Pseudoidentifier - Filter for entries ending with the text | |
pseudoidentifier.not |
query | string | No | Pseudoidentifier - Filter for full text mismatches | |
pseudoidentifier.not.anyOf |
query | array | No | Pseudoidentifier - Filter for entries where at least one reference mismatches the query | |
pseudoidentifier.not.beginsWith |
query | string | No | Pseudoidentifier - Filter for entries not starting with the text | |
pseudoidentifier.not.contains |
query | string | No | Pseudoidentifier - Filter for partial text mismatches | |
pseudoidentifier.not.endsWith |
query | string | No | Pseudoidentifier - Filter for entries not ending with the text | |
race |
query | string | No | Race - Filter for a matching concept code | |
race.anyOf |
query | array | No | Race - Filter for a matching set of concept codes | |
race.descendantsOf |
query | string | No | Race - Filter for all child concepts of a given concepts code | |
race.exists |
query | boolean | No | Race - Filter for entries with a value | |
race.not |
query | string | No | Race - Filter for a mismatching concept code | |
race.not.anyOf |
query | array | No | Race - Filter for a mismmatching set of concept codes | |
race.not.exists |
query | boolean | No | Race - Filter for entries without a value | |
sexAtBirth |
query | string | No | Birth sex - Filter for a matching concept code | |
sexAtBirth.anyOf |
query | array | No | Birth sex - Filter for a matching set of concept codes | |
sexAtBirth.descendantsOf |
query | string | No | Birth sex - Filter for all child concepts of a given concepts code | |
sexAtBirth.exists |
query | boolean | No | Birth sex - Filter for entries with a value | |
sexAtBirth.not |
query | string | No | Birth sex - Filter for a mismatching concept code | |
sexAtBirth.not.anyOf |
query | array | No | Birth sex - Filter for a mismmatching set of concept codes | |
sexAtBirth.not.exists |
query | boolean | No | Birth sex - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
vitalStatus |
query | None | No | Vital status - Filter for single value choice | |
vitalStatus.anyOf |
query | array | No | Vital status - ('Filter for excluding a subset of value choices',) | |
vitalStatus.not |
query | None | No | Vital status - ('Filter for all but a single value choice',) |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"age": null,
"dateOfBirth": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"id": "d0ce5915-63dd-43b8-b710-6048cec87280",
"externalSource": "string",
"externalSourceId": "string",
"pseudoidentifier": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/patient-cases¶
Create Patient Case
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": "2022-04-13",
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string",
"x-expanded": false
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string",
"x-expanded": false
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status",
"x-expanded": false
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-expanded": false,
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-expanded": false,
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-expanded": false,
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-expanded": false,
"x-terminology": "GenderIdentity"
},
"dateOfBirth": {
"description": "Anonymized date of birth (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of birth",
"type": "string",
"x-expanded": false
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status",
"x-expanded": false
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string",
"x-expanded": false
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-expanded": false,
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string",
"x-expanded": false
}
},
"required": [
"clinicalCenter",
"clinicalIdentifier",
"gender",
"dateOfBirth"
],
"title": "PatientCaseCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/patient-cases/{caseId}¶
Get Patient Case By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
path | string | No | ||
clinicalCenter |
query | None | No | ||
type |
query | None | id | No |
Response 200 OK
{
"anonymized": true,
"age": null,
"dateOfBirth": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"id": "3772c272-04d8-4a4c-9fc4-afc8607a7001",
"externalSource": "string",
"externalSourceId": "string",
"pseudoidentifier": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years",
"title": "Age"
},
"dateOfBirth": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"const": "*************",
"type": "string"
}
],
"description": "Date of birth of the patient",
"title": "Date of birth"
},
"overallSurvival": {
"description": "Overall survival of the patient since diagnosis",
"title": "Overall survival",
"type": "number"
},
"ageAtDiagnosis": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years at the time of the initial diagnosis",
"title": "Age at diagnosis"
},
"dataCompletionRate": {
"description": "Percentage indicating the completeness of a case in terms of its data.",
"title": "Data completion rate",
"type": "number"
},
"contributors": {
"description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
"items": {
"type": "string"
},
"title": "Data contributors",
"type": "array"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"pseudoidentifier": {
"description": "Pseudoidentifier of the patient",
"maxLength": 40,
"title": "Pseudoidentifier",
"type": "string",
"x-expanded": false
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string",
"x-expanded": false
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string",
"x-expanded": false
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status",
"x-expanded": false
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-expanded": false,
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-expanded": false,
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-expanded": false,
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-expanded": false,
"x-terminology": "GenderIdentity"
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status",
"x-expanded": false
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string",
"x-expanded": false
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-expanded": false,
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"age",
"dateOfBirth",
"dataCompletionRate",
"contributors",
"id",
"pseudoidentifier",
"clinicalCenter",
"clinicalIdentifier",
"gender",
"description"
],
"title": "PatientCase",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/patient-cases/{caseId}¶
Update Patient Case
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": "2022-04-13",
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string",
"x-expanded": false
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string",
"x-expanded": false
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status",
"x-expanded": false
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-expanded": false,
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-expanded": false,
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-expanded": false,
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-expanded": false,
"x-terminology": "GenderIdentity"
},
"dateOfBirth": {
"description": "Anonymized date of birth (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of birth",
"type": "string",
"x-expanded": false
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices",
"maxLength": 20
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status",
"x-expanded": false
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string",
"x-expanded": false
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-expanded": false,
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string",
"x-expanded": false
}
},
"required": [
"clinicalCenter",
"clinicalIdentifier",
"gender",
"dateOfBirth"
],
"title": "PatientCaseCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/patient-cases/{caseId}¶
Delete Patient Case
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/patient-cases/{caseId}/history/events¶
Get All Patient Case History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/patient-cases/{caseId}/history/events/{eventId}¶
Get Patient Case History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
eventId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/patient-cases/{caseId}/history/events/{eventId}/reversion¶
Revert Patient Case To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
eventId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/patient-cases/{caseId}/data-completion/{category}¶
Get Patient Case Data Completion Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
category |
path | string | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"status": {
"description": "Boolean indicating whether the data category has been marked as completed",
"title": "Status",
"type": "boolean"
},
"username": {
"description": "Username of the person who marked the category as completed",
"title": "Username",
"type": "string"
},
"timestamp": {
"description": "Username of the person who marked the category as completed",
"format": "date-time",
"title": "Timestamp",
"type": "string"
}
},
"required": [
"status"
],
"title": "PatientCaseDataCompletionStatusSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/patient-cases/{caseId}/data-completion/{category}¶
Create Patient Case Data Completion
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
category |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/patient-cases/{caseId}/data-completion/{category}¶
Delete Patient Case Data Completion
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
category |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/autocomplete/clinical-centers¶
Get Clinical Centers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
query |
query | string | No |
Response 200 OK
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 501 Not Implemented
Neoplastic Entities¶
GET /api/v1/neoplastic-entities¶
Get All Neoplastic Entities Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
assertionDate.after |
query | string | No | Assertion date - Filter for entries with dates after the specified value | |
assertionDate.before |
query | string | No | Assertion date - Filter for entries with dates before the specified value | |
assertionDate.between |
query | array | No | Assertion date - Filter for entries with dates between two specified values (inclusive) | |
assertionDate.not.between |
query | array | No | Assertion date - Filter for entries with dates not between two specified values (inclusive) | |
assertionDate.not.on |
query | string | No | Assertion date - Filter for entries with dates not matching the specified value | |
assertionDate.on |
query | string | No | Assertion date - Filter for entries with dates exactly matching the specified value | |
assertionDate.onOrAfter |
query | string | No | Assertion date - Filter for entries with dates on or after the specified value | |
assertionDate.onOrBefore |
query | string | No | Assertion date - Filter for entries with dates on or before the specified value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
differentitation |
query | string | No | Differentiation - Filter for a matching concept code | |
differentitation.anyOf |
query | array | No | Differentiation - Filter for a matching set of concept codes | |
differentitation.descendantsOf |
query | string | No | Differentiation - Filter for all child concepts of a given concepts code | |
differentitation.exists |
query | boolean | No | Differentiation - Filter for entries with a value | |
differentitation.not |
query | string | No | Differentiation - Filter for a mismatching concept code | |
differentitation.not.anyOf |
query | array | No | Differentiation - Filter for a mismmatching set of concept codes | |
differentitation.not.exists |
query | boolean | No | Differentiation - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
laterality |
query | string | No | Laterality - Filter for a matching concept code | |
laterality.anyOf |
query | array | No | Laterality - Filter for a matching set of concept codes | |
laterality.descendantsOf |
query | string | No | Laterality - Filter for all child concepts of a given concepts code | |
laterality.exists |
query | boolean | No | Laterality - Filter for entries with a value | |
laterality.not |
query | string | No | Laterality - Filter for a mismatching concept code | |
laterality.not.anyOf |
query | array | No | Laterality - Filter for a mismmatching set of concept codes | |
laterality.not.exists |
query | boolean | No | Laterality - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
morphology |
query | string | No | Morphology - Filter for a matching concept code | |
morphology.anyOf |
query | array | No | Morphology - Filter for a matching set of concept codes | |
morphology.descendantsOf |
query | string | No | Morphology - Filter for all child concepts of a given concepts code | |
morphology.not |
query | string | No | Morphology - Filter for a mismatching concept code | |
morphology.not.anyOf |
query | array | No | Morphology - Filter for a mismmatching set of concept codes | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
relatedPrimaryId |
query | string | No | Related primary neoplasm - Filter for reference matches | |
relatedPrimaryId.anyOf |
query | array | No | Related primary neoplasm - Filter for entries where at least one reference matches the query | |
relatedPrimaryId.beginsWith |
query | string | No | Related primary neoplasm - Filter for entries starting with the text | |
relatedPrimaryId.contains |
query | string | No | Related primary neoplasm - Filter for partial text matches | |
relatedPrimaryId.endsWith |
query | string | No | Related primary neoplasm - Filter for entries ending with the text | |
relatedPrimaryId.exists |
query | boolean | No | Related primary neoplasm - Filter for entries with a value | |
relatedPrimaryId.not |
query | string | No | Related primary neoplasm - Filter for reference mismatches | |
relatedPrimaryId.not.anyOf |
query | array | No | Related primary neoplasm - Filter for entries where at least one reference mismatches the query | |
relatedPrimaryId.not.beginsWith |
query | string | No | Related primary neoplasm - Filter for entries not starting with the text | |
relatedPrimaryId.not.contains |
query | string | No | Related primary neoplasm - Filter for partial text mismatches | |
relatedPrimaryId.not.endsWith |
query | string | No | Related primary neoplasm - Filter for entries not ending with the text | |
relatedPrimaryId.not.exists |
query | boolean | No | Related primary neoplasm - Filter for entries without a value | |
relationship |
query | None | No | Neoplastic relationship - Filter for single value choice | |
relationship.anyOf |
query | array | No | Neoplastic relationship - ('Filter for excluding a subset of value choices',) | |
relationship.not |
query | None | No | Neoplastic relationship - ('Filter for all but a single value choice',) | |
topography |
query | string | No | Topography - Filter for a matching concept code | |
topography.anyOf |
query | array | No | Topography - Filter for a matching set of concept codes | |
topography.descendantsOf |
query | string | No | Topography - Filter for all child concepts of a given concepts code | |
topography.not |
query | string | No | Topography - Filter for a mismatching concept code | |
topography.not.anyOf |
query | array | No | Topography - Filter for a mismmatching set of concept codes | |
topographyGroup |
query | string | No | Topographical group - Filter for a matching concept code | |
topographyGroup.anyOf |
query | array | No | Topographical group - Filter for a matching set of concept codes | |
topographyGroup.descendantsOf |
query | string | No | Topographical group - Filter for all child concepts of a given concepts code | |
topographyGroup.exists |
query | boolean | No | Topographical group - Filter for entries with a value | |
topographyGroup.not |
query | string | No | Topographical group - Filter for a mismatching concept code | |
topographyGroup.not.anyOf |
query | array | No | Topographical group - Filter for a mismmatching set of concept codes | |
topographyGroup.not.exists |
query | boolean | No | Topographical group - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"topographyGroup": null,
"id": "90a66057-7331-41fb-8376-9a5c40ce0c7a",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "729fc55c-0c71-449a-bad1-4eb438683d58",
"relationship": "primary",
"relatedPrimaryId": "4f5bf5fb-d002-4c24-b3be-80992ac810ca",
"assertionDate": "2022-04-13",
"topography": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"morphology": null,
"differentitation": null,
"laterality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Schema of the response body
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/neoplastic-entities¶
Create Neoplastic Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a76fcc5b-5143-45ef-a721-aa7bbca27306",
"relationship": "primary",
"relatedPrimaryId": "50325a68-53e6-44e9-9308-ccfe1a15edc6",
"assertionDate": "2022-04-13",
"topography": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"morphology": null,
"differentitation": null,
"laterality": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's neoplasm(s) are recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"relationship": {
"$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
"description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
"maxLength": 30,
"title": "Neoplastic relationship",
"x-expanded": false
},
"relatedPrimaryId": {
"description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
"format": "uuid",
"title": "Related primary neoplasm",
"type": "string",
"x-expanded": false
},
"assertionDate": {
"description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
"format": "date",
"title": "Assertion date",
"type": "string",
"x-expanded": false
},
"topography": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the neoplasm(s)",
"title": "Topography",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"morphology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
"title": "Morphology",
"x-expanded": false,
"x-terminology": "CancerMorphology"
},
"differentitation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphologic differentitation characteristics of the neoplasm(s)",
"title": "Differentiation",
"x-expanded": false,
"x-terminology": "HistologyDifferentiation"
},
"laterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality qualifier for the location of the neoplasm(s)",
"title": "Laterality",
"x-expanded": false,
"x-terminology": "LateralityQualifier"
}
},
"required": [
"caseId",
"relationship",
"assertionDate",
"topography",
"morphology"
],
"title": "NeoplasticEntityCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/neoplastic-entities/{entityId}¶
Get Neoplastic Entity By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
entityId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"topographyGroup": null,
"id": "58cdd71a-754f-4eb0-bd05-1ffabacb1603",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "453942bd-e551-4f67-acf4-12e1bea4bf10",
"relationship": "primary",
"relatedPrimaryId": "482b7b8c-3a41-4f15-be0e-70707b2d5435",
"assertionDate": "2022-04-13",
"topography": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"morphology": null,
"differentitation": null,
"laterality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"topographyGroup": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Broad anatomical location of the neoplastic entity",
"title": "Topographical group",
"x-terminology": "CancerTopographyGroup"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's neoplasm(s) are recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"relationship": {
"$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
"description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
"maxLength": 30,
"title": "Neoplastic relationship",
"x-expanded": false
},
"relatedPrimaryId": {
"description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
"format": "uuid",
"title": "Related primary neoplasm",
"type": "string",
"x-expanded": false
},
"assertionDate": {
"description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
"format": "date",
"title": "Assertion date",
"type": "string",
"x-expanded": false
},
"topography": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the neoplasm(s)",
"title": "Topography",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"morphology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
"title": "Morphology",
"x-expanded": false,
"x-terminology": "CancerMorphology"
},
"differentitation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphologic differentitation characteristics of the neoplasm(s)",
"title": "Differentiation",
"x-expanded": false,
"x-terminology": "HistologyDifferentiation"
},
"laterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality qualifier for the location of the neoplasm(s)",
"title": "Laterality",
"x-expanded": false,
"x-terminology": "LateralityQualifier"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"relationship",
"assertionDate",
"topography",
"morphology",
"description"
],
"title": "NeoplasticEntity",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/neoplastic-entities/{entityId}¶
Update Neoplastic Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "960ff02f-3805-4f3a-b7b8-95ee4ba5705b",
"relationship": "primary",
"relatedPrimaryId": "7b0b2abc-4088-42e1-9f11-df2eb6d0fdb3",
"assertionDate": "2022-04-13",
"topography": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"morphology": null,
"differentitation": null,
"laterality": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's neoplasm(s) are recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"relationship": {
"$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
"description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
"maxLength": 30,
"title": "Neoplastic relationship",
"x-expanded": false
},
"relatedPrimaryId": {
"description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
"format": "uuid",
"title": "Related primary neoplasm",
"type": "string",
"x-expanded": false
},
"assertionDate": {
"description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
"format": "date",
"title": "Assertion date",
"type": "string",
"x-expanded": false
},
"topography": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the neoplasm(s)",
"title": "Topography",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"morphology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
"title": "Morphology",
"x-expanded": false,
"x-terminology": "CancerMorphology"
},
"differentitation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphologic differentitation characteristics of the neoplasm(s)",
"title": "Differentiation",
"x-expanded": false,
"x-terminology": "HistologyDifferentiation"
},
"laterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality qualifier for the location of the neoplasm(s)",
"title": "Laterality",
"x-expanded": false,
"x-terminology": "LateralityQualifier"
}
},
"required": [
"caseId",
"relationship",
"assertionDate",
"topography",
"morphology"
],
"title": "NeoplasticEntityCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/neoplastic-entities/{entityId}¶
Delete Neoplastic Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/neoplastic-entities/{entityId}/history/events¶
Get All Neoplastic Entity History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/neoplastic-entities/{entityId}/history/events/{eventId}¶
Get Neoplastic Entity History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No | ||
eventId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/neoplastic-entities/{entityId}/history/events/{eventId}/reversion¶
Revert Neoplastic Entity To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No | ||
eventId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Stagings¶
GET /api/v1/stagings¶
Get All Stagings Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Staging date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Staging date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Staging date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Staging date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Staging date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Staging date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Staging date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Staging date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
stage |
query | string | No | Stage - Filter for a matching concept code | |
stage.anyOf |
query | array | No | Stage - Filter for a matching set of concept codes | |
stage.descendantsOf |
query | string | No | Stage - Filter for all child concepts of a given concepts code | |
stage.not |
query | string | No | Stage - Filter for a mismatching concept code | |
stage.not.anyOf |
query | array | No | Stage - Filter for a mismmatching set of concept codes | |
stagedEntitiesIds |
query | string | No | Staged neoplastic entities - Filter for full text matches | |
stagedEntitiesIds.anyOf |
query | array | No | Staged neoplastic entities - Filter for entries where at least one reference matches the query | |
stagedEntitiesIds.beginsWith |
query | string | No | Staged neoplastic entities - Filter for entries starting with the text | |
stagedEntitiesIds.contains |
query | string | No | Staged neoplastic entities - Filter for partial text matches | |
stagedEntitiesIds.endsWith |
query | string | No | Staged neoplastic entities - Filter for entries ending with the text | |
stagedEntitiesIds.not |
query | string | No | Staged neoplastic entities - Filter for full text mismatches | |
stagedEntitiesIds.not.anyOf |
query | array | No | Staged neoplastic entities - Filter for entries where at least one reference mismatches the query | |
stagedEntitiesIds.not.beginsWith |
query | string | No | Staged neoplastic entities - Filter for entries not starting with the text | |
stagedEntitiesIds.not.contains |
query | string | No | Staged neoplastic entities - Filter for partial text mismatches | |
stagedEntitiesIds.not.endsWith |
query | string | No | Staged neoplastic entities - Filter for entries not ending with the text | |
stagingDomain |
query | None | No | Staging domain - Filter for single value choice | |
stagingDomain.anyOf |
query | array | No | Staging domain - ('Filter for excluding a subset of value choices',) | |
stagingDomain.not |
query | None | No | Staging domain - ('Filter for all but a single value choice',) | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/stagings¶
Create Staging
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TNMStagingCreate"
},
{
"$ref": "#/components/schemas/FIGOStagingCreate"
},
{
"$ref": "#/components/schemas/BinetStagingCreate"
},
{
"$ref": "#/components/schemas/RaiStagingCreate"
},
{
"$ref": "#/components/schemas/BreslowDepthCreate"
},
{
"$ref": "#/components/schemas/ClarkStagingCreate"
},
{
"$ref": "#/components/schemas/ISSStagingCreate"
},
{
"$ref": "#/components/schemas/RISSStagingCreate"
},
{
"$ref": "#/components/schemas/GleasonGradeCreate"
},
{
"$ref": "#/components/schemas/INSSStageCreate"
},
{
"$ref": "#/components/schemas/INRGSSStageCreate"
},
{
"$ref": "#/components/schemas/WilmsStageCreate"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroupCreate"
},
{
"$ref": "#/components/schemas/LymphomaStagingCreate"
}
],
"title": "Payload"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/stagings/{stagingId}¶
Get Staging By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
stagingId |
path | string | No |
Response 200 OK
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/TNMStaging"
},
{
"$ref": "#/components/schemas/FIGOStaging"
},
{
"$ref": "#/components/schemas/BinetStaging"
},
{
"$ref": "#/components/schemas/RaiStaging"
},
{
"$ref": "#/components/schemas/BreslowDepth"
},
{
"$ref": "#/components/schemas/ClarkStaging"
},
{
"$ref": "#/components/schemas/ISSStaging"
},
{
"$ref": "#/components/schemas/RISSStaging"
},
{
"$ref": "#/components/schemas/GleasonGrade"
},
{
"$ref": "#/components/schemas/INSSStage"
},
{
"$ref": "#/components/schemas/INRGSSStage"
},
{
"$ref": "#/components/schemas/WilmsStage"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
},
{
"$ref": "#/components/schemas/LymphomaStaging"
}
]
}
Response 404 Not Found
PUT /api/v1/stagings/{stagingId}¶
Update Staging
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
stagingId |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TNMStagingCreate"
},
{
"$ref": "#/components/schemas/FIGOStagingCreate"
},
{
"$ref": "#/components/schemas/BinetStagingCreate"
},
{
"$ref": "#/components/schemas/RaiStagingCreate"
},
{
"$ref": "#/components/schemas/BreslowDepthCreate"
},
{
"$ref": "#/components/schemas/ClarkStagingCreate"
},
{
"$ref": "#/components/schemas/ISSStagingCreate"
},
{
"$ref": "#/components/schemas/RISSStagingCreate"
},
{
"$ref": "#/components/schemas/GleasonGradeCreate"
},
{
"$ref": "#/components/schemas/INSSStageCreate"
},
{
"$ref": "#/components/schemas/INRGSSStageCreate"
},
{
"$ref": "#/components/schemas/WilmsStageCreate"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroupCreate"
},
{
"$ref": "#/components/schemas/LymphomaStagingCreate"
}
],
"title": "Payload"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/stagings/{stagingId}¶
Delete Staging
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
stagingId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/stagings/{stagingId}/history/events¶
Get All Staging History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
stagingId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/stagings/{stagingId}/history/events/{eventId}¶
Get Staging History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
stagingId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "Represents an audit/history event capturing changes in the system.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEvent",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/stagings/{stagingId}/history/events/{eventId}/reversion¶
Revert Staging To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
stagingId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Risk Assessments¶
GET /api/v1/risk-assessments¶
Get All Risk Assessments Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
assessedEntitiesIds |
query | string | No | Assessed neoplastic entities - Filter for full text matches | |
assessedEntitiesIds.anyOf |
query | array | No | Assessed neoplastic entities - Filter for entries where at least one reference matches the query | |
assessedEntitiesIds.beginsWith |
query | string | No | Assessed neoplastic entities - Filter for entries starting with the text | |
assessedEntitiesIds.contains |
query | string | No | Assessed neoplastic entities - Filter for partial text matches | |
assessedEntitiesIds.endsWith |
query | string | No | Assessed neoplastic entities - Filter for entries ending with the text | |
assessedEntitiesIds.not |
query | string | No | Assessed neoplastic entities - Filter for full text mismatches | |
assessedEntitiesIds.not.anyOf |
query | array | No | Assessed neoplastic entities - Filter for entries where at least one reference mismatches the query | |
assessedEntitiesIds.not.beginsWith |
query | string | No | Assessed neoplastic entities - Filter for entries not starting with the text | |
assessedEntitiesIds.not.contains |
query | string | No | Assessed neoplastic entities - Filter for partial text mismatches | |
assessedEntitiesIds.not.endsWith |
query | string | No | Assessed neoplastic entities - Filter for entries not ending with the text | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
methodology |
query | string | No | Assessment methodology - Filter for a matching concept code | |
methodology.anyOf |
query | array | No | Assessment methodology - Filter for a matching set of concept codes | |
methodology.descendantsOf |
query | string | No | Assessment methodology - Filter for all child concepts of a given concepts code | |
methodology.not |
query | string | No | Assessment methodology - Filter for a mismatching concept code | |
methodology.not.anyOf |
query | array | No | Assessment methodology - Filter for a mismmatching set of concept codes | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
risk |
query | string | No | Risk - Filter for a matching concept code | |
risk.anyOf |
query | array | No | Risk - Filter for a matching set of concept codes | |
risk.descendantsOf |
query | string | No | Risk - Filter for all child concepts of a given concepts code | |
risk.not |
query | string | No | Risk - Filter for a mismatching concept code | |
risk.not.anyOf |
query | array | No | Risk - Filter for a mismmatching set of concept codes | |
score.between |
query | array | No | Score - Filter for entries with values between two specified values (inclusive) | |
score.equal |
query | number | No | Score - Filter for entries with values exactly equal to the specified value | |
score.exists |
query | boolean | No | Score - Filter for entries with a value | |
score.greaterThan |
query | number | No | Score - Filter for entries with values greater than the specified value | |
score.greaterThanOrEqual |
query | number | No | Score - Filter for entries with values greater than or equal to the specified value | |
score.lessThan |
query | number | No | Score - Filter for entries with values less than the specified value | |
score.lessThanOrEqual |
query | number | No | Score - Filter for entries with values less than or equal to the specified value | |
score.not.between |
query | array | No | Score - Filter for entries with values between two specified values (inclusive) | |
score.not.equal |
query | number | No | Score - Filter for entries with values not equal to the specified value | |
score.not.exists |
query | boolean | No | Score - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "6d27eb03-764e-48c2-958e-8664d176e863",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "dcd77ccf-98c3-45b6-a6dd-66badd891f0c",
"date": "2022-04-13",
"methodology": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"bcda8e56-e5c8-437f-92f6-cf7c33d6b7a4"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/risk-assessments¶
Create Risk Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e9071ca0-0bcf-47c5-b330-c659723f945d",
"date": "2022-04-13",
"methodology": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"5a286443-a28c-4096-bf4d-5e8dc0d5ab4b"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's cancer risk is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Indicates the method or type of risk assessment",
"title": "Assessment methodology",
"x-expanded": false,
"x-terminology": "CancerRiskAssessmentMethod"
},
"risk": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Assessed risk",
"title": "Risk",
"x-expanded": false,
"x-terminology": "CancerRiskAssessmentClassification"
},
"score": {
"description": "Quantitative score used to classify the risk",
"title": "Score",
"type": "number",
"x-expanded": false
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assessed to estimate the risk.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"date",
"methodology",
"risk"
],
"title": "RiskAssessmentCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/risk-assessments/{riskAssessmentId}¶
Get Risk Assessment By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
riskAssessmentId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"id": "1863c192-08c4-4c00-82e7-48f16b6ce979",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "1f1fc47b-d446-45fe-8492-9e1775812e19",
"date": "2022-04-13",
"methodology": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"e23fc297-a378-4591-a119-6156d150ba6c"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's cancer risk is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Indicates the method or type of risk assessment",
"title": "Assessment methodology",
"x-expanded": false,
"x-terminology": "CancerRiskAssessmentMethod"
},
"risk": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Assessed risk",
"title": "Risk",
"x-expanded": false,
"x-terminology": "CancerRiskAssessmentClassification"
},
"score": {
"description": "Quantitative score used to classify the risk",
"title": "Score",
"type": "number",
"x-expanded": false
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assessed to estimate the risk.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"methodology",
"risk",
"description"
],
"title": "RiskAssessment",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/risk-assessments/{riskAssessmentId}¶
Update Risk Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
riskAssessmentId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2274078b-0d07-45c2-8224-b4319609bde1",
"date": "2022-04-13",
"methodology": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"7d79013c-91c1-4451-a608-f3994b20dfd5"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's cancer risk is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Indicates the method or type of risk assessment",
"title": "Assessment methodology",
"x-expanded": false,
"x-terminology": "CancerRiskAssessmentMethod"
},
"risk": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Assessed risk",
"title": "Risk",
"x-expanded": false,
"x-terminology": "CancerRiskAssessmentClassification"
},
"score": {
"description": "Quantitative score used to classify the risk",
"title": "Score",
"type": "number",
"x-expanded": false
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assessed to estimate the risk.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"date",
"methodology",
"risk"
],
"title": "RiskAssessmentCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/risk-assessments/{riskAssessmentId}¶
Delete Risk Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
riskAssessmentId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/risk-assessments/{riskAssessmentId}/history/events¶
Get All Risk Assessment History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
riskAssessmentId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/risk-assessments/{riskAssessmentId}/history/events/{eventId}¶
Get Risk Assessment History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
riskAssessmentId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/risk-assessments/{riskAssessmentId}/history/events/{eventId}/reversion¶
Revert Risk Assessment To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
riskAssessmentId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Tumor Markers¶
GET /api/v1/tumor-markers¶
Get All Tumor Markers Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
analyte |
query | string | No | Analyte - Filter for a matching concept code | |
analyte.anyOf |
query | array | No | Analyte - Filter for a matching set of concept codes | |
analyte.descendantsOf |
query | string | No | Analyte - Filter for all child concepts of a given concepts code | |
analyte.not |
query | string | No | Analyte - Filter for a mismatching concept code | |
analyte.not.anyOf |
query | array | No | Analyte - Filter for a mismmatching set of concept codes | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
arbitraryConcentration.between |
query | array | No | Arbitrary concentration - Filter for entries with values between two specified values (inclusive) | |
arbitraryConcentration.equal |
query | number | No | Arbitrary concentration - Filter for entries with values exactly equal to the specified value | |
arbitraryConcentration.exists |
query | boolean | No | Arbitrary concentration - Filter for entries with a value | |
arbitraryConcentration.greaterThan |
query | number | No | Arbitrary concentration - Filter for entries with values greater than the specified value | |
arbitraryConcentration.greaterThanOrEqual |
query | number | No | Arbitrary concentration - Filter for entries with values greater than or equal to the specified value | |
arbitraryConcentration.lessThan |
query | number | No | Arbitrary concentration - Filter for entries with values less than the specified value | |
arbitraryConcentration.lessThanOrEqual |
query | number | No | Arbitrary concentration - Filter for entries with values less than or equal to the specified value | |
arbitraryConcentration.not.between |
query | array | No | Arbitrary concentration - Filter for entries with values between two specified values (inclusive) | |
arbitraryConcentration.not.equal |
query | number | No | Arbitrary concentration - Filter for entries with values not equal to the specified value | |
arbitraryConcentration.not.exists |
query | boolean | No | Arbitrary concentration - Filter for entries without a value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
combinedPositiveScore.between |
query | array | No | Combined Positive Score (CPS) - Filter for entries with values between two specified values (inclusive) | |
combinedPositiveScore.equal |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values exactly equal to the specified value | |
combinedPositiveScore.exists |
query | boolean | No | Combined Positive Score (CPS) - Filter for entries with a value | |
combinedPositiveScore.greaterThan |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values greater than the specified value | |
combinedPositiveScore.greaterThanOrEqual |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values greater than or equal to the specified value | |
combinedPositiveScore.lessThan |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values less than the specified value | |
combinedPositiveScore.lessThanOrEqual |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values less than or equal to the specified value | |
combinedPositiveScore.not.between |
query | array | No | Combined Positive Score (CPS) - Filter for entries with values between two specified values (inclusive) | |
combinedPositiveScore.not.equal |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values not equal to the specified value | |
combinedPositiveScore.not.exists |
query | boolean | No | Combined Positive Score (CPS) - Filter for entries without a value | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
fraction.between |
query | array | No | Fraction - Filter for entries with values between two specified values (inclusive) | |
fraction.equal |
query | number | No | Fraction - Filter for entries with values exactly equal to the specified value | |
fraction.exists |
query | boolean | No | Fraction - Filter for entries with a value | |
fraction.greaterThan |
query | number | No | Fraction - Filter for entries with values greater than the specified value | |
fraction.greaterThanOrEqual |
query | number | No | Fraction - Filter for entries with values greater than or equal to the specified value | |
fraction.lessThan |
query | number | No | Fraction - Filter for entries with values less than the specified value | |
fraction.lessThanOrEqual |
query | number | No | Fraction - Filter for entries with values less than or equal to the specified value | |
fraction.not.between |
query | array | No | Fraction - Filter for entries with values between two specified values (inclusive) | |
fraction.not.equal |
query | number | No | Fraction - Filter for entries with values not equal to the specified value | |
fraction.not.exists |
query | boolean | No | Fraction - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
immuneCellScore |
query | None | No | Immune Cells Score (ICS) - Filter for single value choice | |
immuneCellScore.anyOf |
query | array | No | Immune Cells Score (ICS) - ('Filter for excluding a subset of value choices',) | |
immuneCellScore.exists |
query | boolean | No | Immune Cells Score (ICS) - Filter for entries with a value | |
immuneCellScore.not |
query | None | No | Immune Cells Score (ICS) - ('Filter for all but a single value choice',) | |
immuneCellScore.not.exists |
query | boolean | No | Immune Cells Score (ICS) - Filter for entries without a value | |
immunohistochemicalScore |
query | None | No | Immunohistochemical Score - Filter for single value choice | |
immunohistochemicalScore.anyOf |
query | array | No | Immunohistochemical Score - ('Filter for excluding a subset of value choices',) | |
immunohistochemicalScore.exists |
query | boolean | No | Immunohistochemical Score - Filter for entries with a value | |
immunohistochemicalScore.not |
query | None | No | Immunohistochemical Score - ('Filter for all but a single value choice',) | |
immunohistochemicalScore.not.exists |
query | boolean | No | Immunohistochemical Score - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
massConcentration.between |
query | array | No | Mass concentration - Filter for entries with values between two specified values (inclusive) | |
massConcentration.equal |
query | number | No | Mass concentration - Filter for entries with values exactly equal to the specified value | |
massConcentration.exists |
query | boolean | No | Mass concentration - Filter for entries with a value | |
massConcentration.greaterThan |
query | number | No | Mass concentration - Filter for entries with values greater than the specified value | |
massConcentration.greaterThanOrEqual |
query | number | No | Mass concentration - Filter for entries with values greater than or equal to the specified value | |
massConcentration.lessThan |
query | number | No | Mass concentration - Filter for entries with values less than the specified value | |
massConcentration.lessThanOrEqual |
query | number | No | Mass concentration - Filter for entries with values less than or equal to the specified value | |
massConcentration.not.between |
query | array | No | Mass concentration - Filter for entries with values between two specified values (inclusive) | |
massConcentration.not.equal |
query | number | No | Mass concentration - Filter for entries with values not equal to the specified value | |
massConcentration.not.exists |
query | boolean | No | Mass concentration - Filter for entries without a value | |
multipleOfMedian.between |
query | array | No | Multiples of the median - Filter for entries with values between two specified values (inclusive) | |
multipleOfMedian.equal |
query | number | No | Multiples of the median - Filter for entries with values exactly equal to the specified value | |
multipleOfMedian.exists |
query | boolean | No | Multiples of the median - Filter for entries with a value | |
multipleOfMedian.greaterThan |
query | number | No | Multiples of the median - Filter for entries with values greater than the specified value | |
multipleOfMedian.greaterThanOrEqual |
query | number | No | Multiples of the median - Filter for entries with values greater than or equal to the specified value | |
multipleOfMedian.lessThan |
query | number | No | Multiples of the median - Filter for entries with values less than the specified value | |
multipleOfMedian.lessThanOrEqual |
query | number | No | Multiples of the median - Filter for entries with values less than or equal to the specified value | |
multipleOfMedian.not.between |
query | array | No | Multiples of the median - Filter for entries with values between two specified values (inclusive) | |
multipleOfMedian.not.equal |
query | number | No | Multiples of the median - Filter for entries with values not equal to the specified value | |
multipleOfMedian.not.exists |
query | boolean | No | Multiples of the median - Filter for entries without a value | |
nuclearExpressionStatus |
query | None | No | Nuclear expression status - Filter for single value choice | |
nuclearExpressionStatus.anyOf |
query | array | No | Nuclear expression status - ('Filter for excluding a subset of value choices',) | |
nuclearExpressionStatus.exists |
query | boolean | No | Nuclear expression status - Filter for entries with a value | |
nuclearExpressionStatus.not |
query | None | No | Nuclear expression status - ('Filter for all but a single value choice',) | |
nuclearExpressionStatus.not.exists |
query | boolean | No | Nuclear expression status - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
presence |
query | None | No | Presence - Filter for single value choice | |
presence.anyOf |
query | array | No | Presence - ('Filter for excluding a subset of value choices',) | |
presence.exists |
query | boolean | No | Presence - Filter for entries with a value | |
presence.not |
query | None | No | Presence - ('Filter for all but a single value choice',) | |
presence.not.exists |
query | boolean | No | Presence - Filter for entries without a value | |
relatedEntitiesIds |
query | string | No | Related neoplastic entities - Filter for full text matches | |
relatedEntitiesIds.anyOf |
query | array | No | Related neoplastic entities - Filter for entries where at least one reference matches the query | |
relatedEntitiesIds.beginsWith |
query | string | No | Related neoplastic entities - Filter for entries starting with the text | |
relatedEntitiesIds.contains |
query | string | No | Related neoplastic entities - Filter for partial text matches | |
relatedEntitiesIds.endsWith |
query | string | No | Related neoplastic entities - Filter for entries ending with the text | |
relatedEntitiesIds.not |
query | string | No | Related neoplastic entities - Filter for full text mismatches | |
relatedEntitiesIds.not.anyOf |
query | array | No | Related neoplastic entities - Filter for entries where at least one reference mismatches the query | |
relatedEntitiesIds.not.beginsWith |
query | string | No | Related neoplastic entities - Filter for entries not starting with the text | |
relatedEntitiesIds.not.contains |
query | string | No | Related neoplastic entities - Filter for partial text mismatches | |
relatedEntitiesIds.not.endsWith |
query | string | No | Related neoplastic entities - Filter for entries not ending with the text | |
substanceConcentration.between |
query | array | No | Substance concentration - Filter for entries with values between two specified values (inclusive) | |
substanceConcentration.equal |
query | number | No | Substance concentration - Filter for entries with values exactly equal to the specified value | |
substanceConcentration.exists |
query | boolean | No | Substance concentration - Filter for entries with a value | |
substanceConcentration.greaterThan |
query | number | No | Substance concentration - Filter for entries with values greater than the specified value | |
substanceConcentration.greaterThanOrEqual |
query | number | No | Substance concentration - Filter for entries with values greater than or equal to the specified value | |
substanceConcentration.lessThan |
query | number | No | Substance concentration - Filter for entries with values less than the specified value | |
substanceConcentration.lessThanOrEqual |
query | number | No | Substance concentration - Filter for entries with values less than or equal to the specified value | |
substanceConcentration.not.between |
query | array | No | Substance concentration - Filter for entries with values between two specified values (inclusive) | |
substanceConcentration.not.equal |
query | number | No | Substance concentration - Filter for entries with values not equal to the specified value | |
substanceConcentration.not.exists |
query | boolean | No | Substance concentration - Filter for entries without a value | |
tumorProportionScore |
query | None | No | Immune Cells Score (ICS) - Filter for single value choice | |
tumorProportionScore.anyOf |
query | array | No | Immune Cells Score (ICS) - ('Filter for excluding a subset of value choices',) | |
tumorProportionScore.exists |
query | boolean | No | Immune Cells Score (ICS) - Filter for entries with a value | |
tumorProportionScore.not |
query | None | No | Immune Cells Score (ICS) - ('Filter for all but a single value choice',) | |
tumorProportionScore.not.exists |
query | boolean | No | Immune Cells Score (ICS) - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "80e1c491-5c78-435a-b4bf-8a15206b1852",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b543e04f-bb5c-4468-b582-10cdd6cfbd7d",
"date": "2022-04-13",
"analyte": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"812f24af-7bc7-4dbc-a521-1d380b5ee65b"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/tumor-markers¶
Create Tumor Marker
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b5e11689-08c8-4576-8f0a-546b2c95ceed",
"date": "2022-04-13",
"analyte": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"a86f4faf-8149-4c43-94e4-c42b3ee63d2c"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient related to the tumor marker result",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the tumor marker was analyzed.",
"format": "date",
"title": "Date",
"type": "string",
"x-expanded": false
},
"analyte": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The chemical or biological substance/agent that is analyzed.",
"title": "Analyte",
"x-expanded": false,
"x-terminology": "TumorMarkerAnalyte"
},
"massConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Mass concentration of the analyte (if revelant/measured)",
"title": "Mass concentration",
"x-default-unit": "g/l",
"x-expanded": false,
"x-measure": "MassConcentration"
},
"arbitraryConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Arbitrary concentration of the analyte (if revelant/measured)",
"title": "Arbitrary concentration",
"x-default-unit": "kIU/l",
"x-expanded": false,
"x-measure": "ArbitraryConcentration"
},
"substanceConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Substance concentration of the analyte (if revelant/measured)",
"title": "Substance concentration",
"x-default-unit": "mol/l",
"x-expanded": false,
"x-measure": "SubstanceConcentration"
},
"fraction": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Analyte fraction (if revelant/measured)",
"title": "Fraction",
"x-default-unit": "%",
"x-expanded": false,
"x-measure": "Fraction"
},
"multipleOfMedian": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Multiples of the median analyte (if revelant/measured)",
"title": "Multiples of the median",
"x-default-unit": "multiple_of_median",
"x-expanded": false,
"x-measure": "MultipleOfMedian"
},
"tumorProportionScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the percentage of cells in a tumor that express PD-L1",
"title": "Immune Cells Score (ICS)",
"x-expanded": false
},
"immuneCellScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the percentage of PD-L1 positive immune cells",
"title": "Immune Cells Score (ICS)",
"x-expanded": false
},
"combinedPositiveScore": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
"title": "Combined Positive Score (CPS)",
"x-default-unit": "%",
"x-expanded": false,
"x-measure": "Fraction"
},
"immunohistochemicalScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the number of analyte-positive cells in a sample",
"title": "Immunohistochemical Score",
"x-expanded": false
},
"presence": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerPresenceChoices",
"maxLength": 50
}
],
"description": "Whether an analyte has tested positive or negative.",
"title": "Presence",
"x-expanded": false
},
"nuclearExpressionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices",
"maxLength": 50
}
],
"description": "Categorization of the status of expression of the analyte",
"title": "Nuclear expression status",
"x-expanded": false
},
"relatedEntitiesIds": {
"description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Related neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"date",
"analyte"
],
"title": "TumorMarkerCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/tumor-markers/{tumorMarkerId}¶
Get Tumor Marker By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
tumorMarkerId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"id": "21e6bae6-43c5-4d78-9ec1-91dfae5e7863",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9c9e0f2c-6ac7-47ee-91c0-ffca96aa7902",
"date": "2022-04-13",
"analyte": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"f4c5c648-fd82-428e-b659-aadb37a4e52c"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient related to the tumor marker result",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the tumor marker was analyzed.",
"format": "date",
"title": "Date",
"type": "string",
"x-expanded": false
},
"analyte": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The chemical or biological substance/agent that is analyzed.",
"title": "Analyte",
"x-expanded": false,
"x-terminology": "TumorMarkerAnalyte"
},
"massConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Mass concentration of the analyte (if revelant/measured)",
"title": "Mass concentration",
"x-default-unit": "g/l",
"x-expanded": false,
"x-measure": "MassConcentration"
},
"arbitraryConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Arbitrary concentration of the analyte (if revelant/measured)",
"title": "Arbitrary concentration",
"x-default-unit": "kIU/l",
"x-expanded": false,
"x-measure": "ArbitraryConcentration"
},
"substanceConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Substance concentration of the analyte (if revelant/measured)",
"title": "Substance concentration",
"x-default-unit": "mol/l",
"x-expanded": false,
"x-measure": "SubstanceConcentration"
},
"fraction": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Analyte fraction (if revelant/measured)",
"title": "Fraction",
"x-default-unit": "%",
"x-expanded": false,
"x-measure": "Fraction"
},
"multipleOfMedian": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Multiples of the median analyte (if revelant/measured)",
"title": "Multiples of the median",
"x-default-unit": "multiple_of_median",
"x-expanded": false,
"x-measure": "MultipleOfMedian"
},
"tumorProportionScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the percentage of cells in a tumor that express PD-L1",
"title": "Immune Cells Score (ICS)",
"x-expanded": false
},
"immuneCellScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the percentage of PD-L1 positive immune cells",
"title": "Immune Cells Score (ICS)",
"x-expanded": false
},
"combinedPositiveScore": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
"title": "Combined Positive Score (CPS)",
"x-default-unit": "%",
"x-expanded": false,
"x-measure": "Fraction"
},
"immunohistochemicalScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the number of analyte-positive cells in a sample",
"title": "Immunohistochemical Score",
"x-expanded": false
},
"presence": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerPresenceChoices",
"maxLength": 50
}
],
"description": "Whether an analyte has tested positive or negative.",
"title": "Presence",
"x-expanded": false
},
"nuclearExpressionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices",
"maxLength": 50
}
],
"description": "Categorization of the status of expression of the analyte",
"title": "Nuclear expression status",
"x-expanded": false
},
"relatedEntitiesIds": {
"description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Related neoplastic entities",
"type": "array",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"analyte",
"description"
],
"title": "TumorMarker",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/tumor-markers/{tumorMarkerId}¶
Update Neoplastic Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorMarkerId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "17ba4de2-5643-43cb-86a0-4345b0f9adcc",
"date": "2022-04-13",
"analyte": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"93649270-e872-49a4-bcc3-42023bdfee6d"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient related to the tumor marker result",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the tumor marker was analyzed.",
"format": "date",
"title": "Date",
"type": "string",
"x-expanded": false
},
"analyte": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The chemical or biological substance/agent that is analyzed.",
"title": "Analyte",
"x-expanded": false,
"x-terminology": "TumorMarkerAnalyte"
},
"massConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Mass concentration of the analyte (if revelant/measured)",
"title": "Mass concentration",
"x-default-unit": "g/l",
"x-expanded": false,
"x-measure": "MassConcentration"
},
"arbitraryConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Arbitrary concentration of the analyte (if revelant/measured)",
"title": "Arbitrary concentration",
"x-default-unit": "kIU/l",
"x-expanded": false,
"x-measure": "ArbitraryConcentration"
},
"substanceConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Substance concentration of the analyte (if revelant/measured)",
"title": "Substance concentration",
"x-default-unit": "mol/l",
"x-expanded": false,
"x-measure": "SubstanceConcentration"
},
"fraction": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Analyte fraction (if revelant/measured)",
"title": "Fraction",
"x-default-unit": "%",
"x-expanded": false,
"x-measure": "Fraction"
},
"multipleOfMedian": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Multiples of the median analyte (if revelant/measured)",
"title": "Multiples of the median",
"x-default-unit": "multiple_of_median",
"x-expanded": false,
"x-measure": "MultipleOfMedian"
},
"tumorProportionScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the percentage of cells in a tumor that express PD-L1",
"title": "Immune Cells Score (ICS)",
"x-expanded": false
},
"immuneCellScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the percentage of PD-L1 positive immune cells",
"title": "Immune Cells Score (ICS)",
"x-expanded": false
},
"combinedPositiveScore": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
"title": "Combined Positive Score (CPS)",
"x-default-unit": "%",
"x-expanded": false,
"x-measure": "Fraction"
},
"immunohistochemicalScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices",
"maxLength": 50
}
],
"description": "Categorization of the number of analyte-positive cells in a sample",
"title": "Immunohistochemical Score",
"x-expanded": false
},
"presence": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerPresenceChoices",
"maxLength": 50
}
],
"description": "Whether an analyte has tested positive or negative.",
"title": "Presence",
"x-expanded": false
},
"nuclearExpressionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices",
"maxLength": 50
}
],
"description": "Categorization of the status of expression of the analyte",
"title": "Nuclear expression status",
"x-expanded": false
},
"relatedEntitiesIds": {
"description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Related neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"date",
"analyte"
],
"title": "TumorMarkerCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/tumor-markers/{tumorMarkerId}¶
Delete Tumor Marker
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorMarkerId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/tumor-markers/{tumorMarkerId}/history/events¶
Get All Tumor Marker History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
tumorMarkerId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/tumor-markers/{tumorMarkerId}/history/events/{eventId}¶
Get Tumor Marker History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
tumorMarkerId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/tumor-markers/{tumorMarkerId}/history/events/{eventId}/reversion¶
Revert Tumor Marker To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
tumorMarkerId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/tumor-markers/analytes/{analyteCode}/details¶
Get Tumor Marker Analyte Details By Code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
analyteCode |
path | string | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"acronym": {
"title": "Acronym",
"type": "string"
},
"display": {
"title": "Display",
"type": "string"
},
"valueTypes": {
"items": {
"$ref": "#/components/schemas/AnalyteResultType"
},
"title": "Valuetypes",
"type": "array"
}
},
"required": [
"acronym",
"display",
"valueTypes"
],
"title": "AnalyteDetails",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Systemic Therapies¶
GET /api/v1/systemic-therapies¶
Get All Systemic Therapies Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adjunctiveRole |
query | string | No | Treatment Role - Filter for a matching concept code | |
adjunctiveRole.anyOf |
query | array | No | Treatment Role - Filter for a matching set of concept codes | |
adjunctiveRole.descendantsOf |
query | string | No | Treatment Role - Filter for all child concepts of a given concepts code | |
adjunctiveRole.exists |
query | boolean | No | Treatment Role - Filter for entries with a value | |
adjunctiveRole.not |
query | string | No | Treatment Role - Filter for a mismatching concept code | |
adjunctiveRole.not.anyOf |
query | array | No | Treatment Role - Filter for a mismmatching set of concept codes | |
adjunctiveRole.not.exists |
query | boolean | No | Treatment Role - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
cycles.between |
query | array | No | Cycles - Filter for entries with values between two specified values (inclusive) | |
cycles.equal |
query | integer | No | Cycles - Filter for entries with values exactly equal to the specified value | |
cycles.exists |
query | boolean | No | Cycles - Filter for entries with a value | |
cycles.greaterThan |
query | integer | No | Cycles - Filter for entries with values greater than the specified value | |
cycles.greaterThanOrEqual |
query | integer | No | Cycles - Filter for entries with values greater than or equal to the specified value | |
cycles.lessThan |
query | integer | No | Cycles - Filter for entries with values less than the specified value | |
cycles.lessThanOrEqual |
query | integer | No | Cycles - Filter for entries with values less than or equal to the specified value | |
cycles.not.between |
query | array | No | Cycles - Filter for entries with values between two specified values (inclusive) | |
cycles.not.equal |
query | integer | No | Cycles - Filter for entries with values not equal to the specified value | |
cycles.not.exists |
query | boolean | No | Cycles - Filter for entries without a value | |
duration.between |
query | array | No | Duration - Filter for entries with values between two specified values (inclusive) | |
duration.equal |
query | number | No | Duration - Filter for entries with values exactly equal to the specified value | |
duration.greaterThan |
query | number | No | Duration - Filter for entries with values greater than the specified value | |
duration.greaterThanOrEqual |
query | number | No | Duration - Filter for entries with values greater than or equal to the specified value | |
duration.lessThan |
query | number | No | Duration - Filter for entries with values less than the specified value | |
duration.lessThanOrEqual |
query | number | No | Duration - Filter for entries with values less than or equal to the specified value | |
duration.not.between |
query | array | No | Duration - Filter for entries with values between two specified values (inclusive) | |
duration.not.equal |
query | number | No | Duration - Filter for entries with values not equal to the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
intent |
query | None | No | Intent - Filter for single value choice | |
intent.anyOf |
query | array | No | Intent - ('Filter for excluding a subset of value choices',) | |
intent.not |
query | None | No | Intent - ('Filter for all but a single value choice',) | |
isAdjunctive |
query | boolean | No | Treatment Role - Filter for yes/no statement | |
isAdjunctive.exists |
query | boolean | No | Treatment Role - Filter for entries with a value | |
isAdjunctive.not.exists |
query | boolean | No | Treatment Role - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
medications.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
medications.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
medications.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
medications.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
medications.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
medications.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
medications.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
medications.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
medications.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
medications.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
medications.dosageMass.between |
query | array | No | Dosage - Fixed Mass - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMass.equal |
query | number | No | Dosage - Fixed Mass - Filter for entries with values exactly equal to the specified value | |
medications.dosageMass.exists |
query | boolean | No | Dosage - Fixed Mass - Filter for entries with a value | |
medications.dosageMass.greaterThan |
query | number | No | Dosage - Fixed Mass - Filter for entries with values greater than the specified value | |
medications.dosageMass.greaterThanOrEqual |
query | number | No | Dosage - Fixed Mass - Filter for entries with values greater than or equal to the specified value | |
medications.dosageMass.lessThan |
query | number | No | Dosage - Fixed Mass - Filter for entries with values less than the specified value | |
medications.dosageMass.lessThanOrEqual |
query | number | No | Dosage - Fixed Mass - Filter for entries with values less than or equal to the specified value | |
medications.dosageMass.not.between |
query | array | No | Dosage - Fixed Mass - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMass.not.equal |
query | number | No | Dosage - Fixed Mass - Filter for entries with values not equal to the specified value | |
medications.dosageMass.not.exists |
query | boolean | No | Dosage - Fixed Mass - Filter for entries without a value | |
medications.dosageMassConcentration.between |
query | array | No | Dosage - Mass concentration - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMassConcentration.equal |
query | number | No | Dosage - Mass concentration - Filter for entries with values exactly equal to the specified value | |
medications.dosageMassConcentration.exists |
query | boolean | No | Dosage - Mass concentration - Filter for entries with a value | |
medications.dosageMassConcentration.greaterThan |
query | number | No | Dosage - Mass concentration - Filter for entries with values greater than the specified value | |
medications.dosageMassConcentration.greaterThanOrEqual |
query | number | No | Dosage - Mass concentration - Filter for entries with values greater than or equal to the specified value | |
medications.dosageMassConcentration.lessThan |
query | number | No | Dosage - Mass concentration - Filter for entries with values less than the specified value | |
medications.dosageMassConcentration.lessThanOrEqual |
query | number | No | Dosage - Mass concentration - Filter for entries with values less than or equal to the specified value | |
medications.dosageMassConcentration.not.between |
query | array | No | Dosage - Mass concentration - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMassConcentration.not.equal |
query | number | No | Dosage - Mass concentration - Filter for entries with values not equal to the specified value | |
medications.dosageMassConcentration.not.exists |
query | boolean | No | Dosage - Mass concentration - Filter for entries without a value | |
medications.dosageMassSurface.between |
query | array | No | Dosage - Mass per body surface - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMassSurface.equal |
query | number | No | Dosage - Mass per body surface - Filter for entries with values exactly equal to the specified value | |
medications.dosageMassSurface.exists |
query | boolean | No | Dosage - Mass per body surface - Filter for entries with a value | |
medications.dosageMassSurface.greaterThan |
query | number | No | Dosage - Mass per body surface - Filter for entries with values greater than the specified value | |
medications.dosageMassSurface.greaterThanOrEqual |
query | number | No | Dosage - Mass per body surface - Filter for entries with values greater than or equal to the specified value | |
medications.dosageMassSurface.lessThan |
query | number | No | Dosage - Mass per body surface - Filter for entries with values less than the specified value | |
medications.dosageMassSurface.lessThanOrEqual |
query | number | No | Dosage - Mass per body surface - Filter for entries with values less than or equal to the specified value | |
medications.dosageMassSurface.not.between |
query | array | No | Dosage - Mass per body surface - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMassSurface.not.equal |
query | number | No | Dosage - Mass per body surface - Filter for entries with values not equal to the specified value | |
medications.dosageMassSurface.not.exists |
query | boolean | No | Dosage - Mass per body surface - Filter for entries without a value | |
medications.dosageRateMass.between |
query | array | No | Dosage rate - Fixed Mass - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMass.equal |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values exactly equal to the specified value | |
medications.dosageRateMass.exists |
query | boolean | No | Dosage rate - Fixed Mass - Filter for entries with a value | |
medications.dosageRateMass.greaterThan |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values greater than the specified value | |
medications.dosageRateMass.greaterThanOrEqual |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values greater than or equal to the specified value | |
medications.dosageRateMass.lessThan |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values less than the specified value | |
medications.dosageRateMass.lessThanOrEqual |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values less than or equal to the specified value | |
medications.dosageRateMass.not.between |
query | array | No | Dosage rate - Fixed Mass - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMass.not.equal |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values not equal to the specified value | |
medications.dosageRateMass.not.exists |
query | boolean | No | Dosage rate - Fixed Mass - Filter for entries without a value | |
medications.dosageRateMassConcentration.between |
query | array | No | Dosage rate - Mass concentration - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMassConcentration.equal |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values exactly equal to the specified value | |
medications.dosageRateMassConcentration.exists |
query | boolean | No | Dosage rate - Mass concentration - Filter for entries with a value | |
medications.dosageRateMassConcentration.greaterThan |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values greater than the specified value | |
medications.dosageRateMassConcentration.greaterThanOrEqual |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values greater than or equal to the specified value | |
medications.dosageRateMassConcentration.lessThan |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values less than the specified value | |
medications.dosageRateMassConcentration.lessThanOrEqual |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values less than or equal to the specified value | |
medications.dosageRateMassConcentration.not.between |
query | array | No | Dosage rate - Mass concentration - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMassConcentration.not.equal |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values not equal to the specified value | |
medications.dosageRateMassConcentration.not.exists |
query | boolean | No | Dosage rate - Mass concentration - Filter for entries without a value | |
medications.dosageRateMassSurface.between |
query | array | No | Dosage rate - Mass per body surface - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMassSurface.equal |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values exactly equal to the specified value | |
medications.dosageRateMassSurface.exists |
query | boolean | No | Dosage rate - Mass per body surface - Filter for entries with a value | |
medications.dosageRateMassSurface.greaterThan |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values greater than the specified value | |
medications.dosageRateMassSurface.greaterThanOrEqual |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values greater than or equal to the specified value | |
medications.dosageRateMassSurface.lessThan |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values less than the specified value | |
medications.dosageRateMassSurface.lessThanOrEqual |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values less than or equal to the specified value | |
medications.dosageRateMassSurface.not.between |
query | array | No | Dosage rate - Mass per body surface - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMassSurface.not.equal |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values not equal to the specified value | |
medications.dosageRateMassSurface.not.exists |
query | boolean | No | Dosage rate - Mass per body surface - Filter for entries without a value | |
medications.dosageRateVolume.between |
query | array | No | Dosage rate - Volume - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateVolume.equal |
query | number | No | Dosage rate - Volume - Filter for entries with values exactly equal to the specified value | |
medications.dosageRateVolume.exists |
query | boolean | No | Dosage rate - Volume - Filter for entries with a value | |
medications.dosageRateVolume.greaterThan |
query | number | No | Dosage rate - Volume - Filter for entries with values greater than the specified value | |
medications.dosageRateVolume.greaterThanOrEqual |
query | number | No | Dosage rate - Volume - Filter for entries with values greater than or equal to the specified value | |
medications.dosageRateVolume.lessThan |
query | number | No | Dosage rate - Volume - Filter for entries with values less than the specified value | |
medications.dosageRateVolume.lessThanOrEqual |
query | number | No | Dosage rate - Volume - Filter for entries with values less than or equal to the specified value | |
medications.dosageRateVolume.not.between |
query | array | No | Dosage rate - Volume - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateVolume.not.equal |
query | number | No | Dosage rate - Volume - Filter for entries with values not equal to the specified value | |
medications.dosageRateVolume.not.exists |
query | boolean | No | Dosage rate - Volume - Filter for entries without a value | |
medications.dosageVolume.between |
query | array | No | Dosage - Volume - Filter for entries with values between two specified values (inclusive) | |
medications.dosageVolume.equal |
query | number | No | Dosage - Volume - Filter for entries with values exactly equal to the specified value | |
medications.dosageVolume.exists |
query | boolean | No | Dosage - Volume - Filter for entries with a value | |
medications.dosageVolume.greaterThan |
query | number | No | Dosage - Volume - Filter for entries with values greater than the specified value | |
medications.dosageVolume.greaterThanOrEqual |
query | number | No | Dosage - Volume - Filter for entries with values greater than or equal to the specified value | |
medications.dosageVolume.lessThan |
query | number | No | Dosage - Volume - Filter for entries with values less than the specified value | |
medications.dosageVolume.lessThanOrEqual |
query | number | No | Dosage - Volume - Filter for entries with values less than or equal to the specified value | |
medications.dosageVolume.not.between |
query | array | No | Dosage - Volume - Filter for entries with values between two specified values (inclusive) | |
medications.dosageVolume.not.equal |
query | number | No | Dosage - Volume - Filter for entries with values not equal to the specified value | |
medications.dosageVolume.not.exists |
query | boolean | No | Dosage - Volume - Filter for entries without a value | |
medications.drug |
query | string | No | Antineoplastic Drug - Filter for a matching concept code | |
medications.drug.anyOf |
query | array | No | Antineoplastic Drug - Filter for a matching set of concept codes | |
medications.drug.descendantsOf |
query | string | No | Antineoplastic Drug - Filter for all child concepts of a given concepts code | |
medications.drug.not |
query | string | No | Antineoplastic Drug - Filter for a mismatching concept code | |
medications.drug.not.anyOf |
query | array | No | Antineoplastic Drug - Filter for a mismmatching set of concept codes | |
medications.externalSource |
query | string | No | External data source - Filter for full text matches | |
medications.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
medications.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
medications.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
medications.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
medications.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
medications.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
medications.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
medications.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
medications.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
medications.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
medications.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
medications.id |
query | string | No | Id - Filter for full text matches | |
medications.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
medications.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
medications.id.contains |
query | string | No | Id - Filter for partial text matches | |
medications.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
medications.id.not |
query | string | No | Id - Filter for full text mismatches | |
medications.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
medications.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
medications.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
medications.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
medications.route |
query | string | No | Route - Filter for a matching concept code | |
medications.route.anyOf |
query | array | No | Route - Filter for a matching set of concept codes | |
medications.route.descendantsOf |
query | string | No | Route - Filter for all child concepts of a given concepts code | |
medications.route.exists |
query | boolean | No | Route - Filter for entries with a value | |
medications.route.not |
query | string | No | Route - Filter for a mismatching concept code | |
medications.route.not.anyOf |
query | array | No | Route - Filter for a mismmatching set of concept codes | |
medications.route.not.exists |
query | boolean | No | Route - Filter for entries without a value | |
medications.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
medications.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
medications.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
medications.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
medications.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
medications.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
medications.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
medications.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
medications.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
medications.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
medications.usedOfflabel |
query | boolean | No | Off-label use - Filter for yes/no statement | |
medications.usedOfflabel.exists |
query | boolean | No | Off-label use - Filter for entries with a value | |
medications.usedOfflabel.not.exists |
query | boolean | No | Off-label use - Filter for entries without a value | |
medications.withinSoc |
query | boolean | No | Within SOC - Filter for yes/no statement | |
medications.withinSoc.exists |
query | boolean | No | Within SOC - Filter for entries with a value | |
medications.withinSoc.not.exists |
query | boolean | No | Within SOC - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
period.containedBy |
query | array | No | Treatment period - Filter for entries whose period are contined by the time period | |
period.contains |
query | array | No | Treatment period - Filter for entries containing the time period | |
period.not.containedBy |
query | array | No | Treatment period - Filter for entries whose period are not contined by the time period | |
period.not.contains |
query | array | No | Treatment period - Filter for entries not containing the time period | |
period.not.overlaps |
query | array | No | Treatment period - Filter for entries not overlapping with the time period | |
period.overlaps |
query | array | No | Treatment period - Filter for entries overlapping with the time period | |
targetedEntitiesIds |
query | string | No | Targeted neoplastic entities - Filter for full text matches | |
targetedEntitiesIds.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference matches the query | |
targetedEntitiesIds.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries starting with the text | |
targetedEntitiesIds.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text matches | |
targetedEntitiesIds.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries ending with the text | |
targetedEntitiesIds.not |
query | string | No | Targeted neoplastic entities - Filter for full text mismatches | |
targetedEntitiesIds.not.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query | |
targetedEntitiesIds.not.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not starting with the text | |
targetedEntitiesIds.not.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text mismatches | |
targetedEntitiesIds.not.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not ending with the text | |
terminationReason |
query | string | No | Termination reason - Filter for a matching concept code | |
terminationReason.anyOf |
query | array | No | Termination reason - Filter for a matching set of concept codes | |
terminationReason.descendantsOf |
query | string | No | Termination reason - Filter for all child concepts of a given concepts code | |
terminationReason.exists |
query | boolean | No | Termination reason - Filter for entries with a value | |
terminationReason.not |
query | string | No | Termination reason - Filter for a mismatching concept code | |
terminationReason.not.anyOf |
query | array | No | Termination reason - Filter for a mismmatching set of concept codes | |
terminationReason.not.exists |
query | boolean | No | Termination reason - Filter for entries without a value | |
therapyLineId |
query | string | No | Therapy line - Filter for reference matches | |
therapyLineId.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference matches the query | |
therapyLineId.beginsWith |
query | string | No | Therapy line - Filter for entries starting with the text | |
therapyLineId.contains |
query | string | No | Therapy line - Filter for partial text matches | |
therapyLineId.endsWith |
query | string | No | Therapy line - Filter for entries ending with the text | |
therapyLineId.exists |
query | boolean | No | Therapy line - Filter for entries with a value | |
therapyLineId.not |
query | string | No | Therapy line - Filter for reference mismatches | |
therapyLineId.not.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference mismatches the query | |
therapyLineId.not.beginsWith |
query | string | No | Therapy line - Filter for entries not starting with the text | |
therapyLineId.not.contains |
query | string | No | Therapy line - Filter for partial text mismatches | |
therapyLineId.not.endsWith |
query | string | No | Therapy line - Filter for entries not ending with the text | |
therapyLineId.not.exists |
query | boolean | No | Therapy line - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"medications": [
{
"id": "ab8d1eb9-94d8-437b-ac52-f3b422d97fae",
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"duration": {
"value": 10.12,
"unit": "string"
},
"id": "ecc40ed4-4041-4034-a445-2c11d666fb0f",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "961bb31e-2361-46fc-9fa1-f72e398fc134",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"isAdjunctive": true,
"terminationReason": null,
"therapyLineId": "32893ef0-8def-435d-a192-9d9cf1b8b31c",
"targetedEntitiesIds": [
"7bbb7045-8f8d-47b6-87c7-c81953a27b15"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/systemic-therapies¶
Create Systemic Therapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "45e392d2-0ae7-4622-80f3-28570c0fe5a9",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "2edcdd8b-a5bd-4308-bc4b-b3c23f1899db",
"targetedEntitiesIds": [
"6877cdf8-4bb3-4ed3-bd98-75f1fc1c70a1"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the systemic therapy",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the therapy was administered to the patient.",
"title": "Treatment period",
"x-expanded": false
},
"cycles": {
"description": "The total number of treatment cycles during the treatment period.",
"title": "Cycles",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/SystemicTherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"adjunctiveRole": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Indicates the role of the adjunctive therapy (if applicable).",
"title": "Treatment Role",
"x-expanded": false,
"x-terminology": "AdjunctiveTherapyRole"
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the systemic therapy",
"title": "Termination reason",
"x-expanded": false,
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the systemic therapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the systemic therapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"period",
"intent"
],
"title": "SystemicTherapyCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/systemic-therapies/{systemicTherapyId}¶
Get Systemic Therapy By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
systemicTherapyId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"medications": [
{
"id": "d5cf5ea5-787a-437d-ad45-d0673fec4f19",
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"duration": {
"value": 10.12,
"unit": "string"
},
"id": "afc4aa90-7f8a-4904-9f96-55d72ecf0367",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f84c750b-b854-4e89-8083-7cf9635758ee",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"isAdjunctive": true,
"terminationReason": null,
"therapyLineId": "b5084c4e-5b81-4c58-902d-6e8add60a2dc",
"targetedEntitiesIds": [
"7486967c-a093-4551-9b49-fda51f23e34b"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"medications": {
"description": "Medications administered during the systemic therapy",
"items": {
"$ref": "#/components/schemas/SystemicTherapyMedication"
},
"title": "Medications",
"type": "array"
},
"duration": {
"$ref": "#/components/schemas/Measure",
"description": "Duration of treatment",
"title": "Duration",
"x-measure": "Time"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the systemic therapy",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the therapy was administered to the patient.",
"title": "Treatment period",
"x-expanded": false
},
"cycles": {
"description": "The total number of treatment cycles during the treatment period.",
"title": "Cycles",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/SystemicTherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"adjunctiveRole": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Indicates the role of the adjunctive therapy (if applicable).",
"title": "Treatment Role",
"x-expanded": false,
"x-terminology": "AdjunctiveTherapyRole"
},
"isAdjunctive": {
"description": "Indicates whether it is adjunctive therapy instead of a primary therapy ",
"title": "Treatment Role",
"type": "boolean",
"x-expanded": false
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the systemic therapy",
"title": "Termination reason",
"x-expanded": false,
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the systemic therapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the systemic therapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"medications",
"duration",
"id",
"caseId",
"period",
"intent",
"isAdjunctive",
"description"
],
"title": "SystemicTherapy",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/systemic-therapies/{systemicTherapyId}¶
Delete Systemic Therapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
systemicTherapyId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/systemic-therapies/{systemicTherapyId}¶
Update Systemic Therapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
systemicTherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f77a83e0-531f-44e6-b8ce-bfa3aa27e9d1",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "1863fa03-e3fd-4f7a-ac28-ec21623afe83",
"targetedEntitiesIds": [
"34c07082-4ffe-4ed7-8ee9-cf2bffcd8a5c"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the systemic therapy",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the therapy was administered to the patient.",
"title": "Treatment period",
"x-expanded": false
},
"cycles": {
"description": "The total number of treatment cycles during the treatment period.",
"title": "Cycles",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/SystemicTherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"adjunctiveRole": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Indicates the role of the adjunctive therapy (if applicable).",
"title": "Treatment Role",
"x-expanded": false,
"x-terminology": "AdjunctiveTherapyRole"
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the systemic therapy",
"title": "Termination reason",
"x-expanded": false,
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the systemic therapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the systemic therapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"period",
"intent"
],
"title": "SystemicTherapyCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/systemic-therapies/{systemicTherapyId}/history/events¶
Get All Systemic Therapy History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
systemicTherapyId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/systemic-therapies/{systemicTherapyId}/history/events/{eventId}¶
Get Systemic Therapy History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/systemic-therapies/{systemicTherapyId}/history/events/{eventId}/reversion¶
Revert Systemic Therapy To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/systemic-therapies/{systemicTherapyId}/medications¶
Get Systemic Therapy Medications Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
systemicTherapyId |
path | string | No |
Response 200 OK
[
{
"id": "415d7413-cd26-44f8-8c19-d837a5a5b505",
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/systemic-therapies/{systemicTherapyId}/medications¶
Create Systemic Therapy Medication
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
systemicTherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"drug": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Antineoplastic drug/medication administered to the patient",
"title": "Antineoplastic Drug",
"x-expanded": false,
"x-terminology": "AntineoplasticAgent"
},
"route": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Drug administration route",
"title": "Route",
"x-expanded": false,
"x-terminology": "DosageRoute"
},
"usedOfflabel": {
"description": "Indicates whether a medication was used off-label at the time of administration",
"title": "Off-label use",
"type": "boolean",
"x-expanded": false
},
"withinSoc": {
"description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
"title": "Within SOC",
"type": "boolean",
"x-expanded": false
},
"dosageMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage - Mass concentration",
"x-default-unit": "g/l",
"x-expanded": false,
"x-measure": "MassConcentration"
},
"dosageMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage - Fixed Mass",
"x-default-unit": "g",
"x-expanded": false,
"x-measure": "Mass"
},
"dosageVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage - Volume",
"x-default-unit": "l",
"x-expanded": false,
"x-measure": "Volume"
},
"dosageMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage - Mass per body surface",
"x-default-unit": "g/square_meter",
"x-expanded": false,
"x-measure": "MassPerArea"
},
"dosageRateMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage rate - Mass concentration",
"x-default-unit": "g/l/s",
"x-expanded": false,
"x-measure": "MassConcentrationPerTime"
},
"dosageRateMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage rate - Fixed Mass",
"x-default-unit": "g/s",
"x-expanded": false,
"x-measure": "MassPerTime"
},
"dosageRateVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage rate - Volume",
"x-default-unit": "l/s",
"x-expanded": false,
"x-measure": "VolumePerTime"
},
"dosageRateMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage rate - Mass per body surface",
"x-default-unit": "g/square_meter/s",
"x-expanded": false,
"x-measure": "MassPerAreaPerTime"
}
},
"required": [
"drug"
],
"title": "SystemicTherapyMedicationCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}¶
Get Systemic Therapy Medication By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Response 200 OK
{
"id": "15e981a4-85bf-4419-a3aa-88e623b419b5",
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"drug": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Antineoplastic drug/medication administered to the patient",
"title": "Antineoplastic Drug",
"x-expanded": false,
"x-terminology": "AntineoplasticAgent"
},
"route": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Drug administration route",
"title": "Route",
"x-expanded": false,
"x-terminology": "DosageRoute"
},
"usedOfflabel": {
"description": "Indicates whether a medication was used off-label at the time of administration",
"title": "Off-label use",
"type": "boolean",
"x-expanded": false
},
"withinSoc": {
"description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
"title": "Within SOC",
"type": "boolean",
"x-expanded": false
},
"dosageMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage - Mass concentration",
"x-default-unit": "g/l",
"x-expanded": false,
"x-measure": "MassConcentration"
},
"dosageMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage - Fixed Mass",
"x-default-unit": "g",
"x-expanded": false,
"x-measure": "Mass"
},
"dosageVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage - Volume",
"x-default-unit": "l",
"x-expanded": false,
"x-measure": "Volume"
},
"dosageMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage - Mass per body surface",
"x-default-unit": "g/square_meter",
"x-expanded": false,
"x-measure": "MassPerArea"
},
"dosageRateMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage rate - Mass concentration",
"x-default-unit": "g/l/s",
"x-expanded": false,
"x-measure": "MassConcentrationPerTime"
},
"dosageRateMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage rate - Fixed Mass",
"x-default-unit": "g/s",
"x-expanded": false,
"x-measure": "MassPerTime"
},
"dosageRateVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage rate - Volume",
"x-default-unit": "l/s",
"x-expanded": false,
"x-measure": "VolumePerTime"
},
"dosageRateMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage rate - Mass per body surface",
"x-default-unit": "g/square_meter/s",
"x-expanded": false,
"x-measure": "MassPerAreaPerTime"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"drug",
"description"
],
"title": "SystemicTherapyMedication",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}¶
Update Systemic Therapy Medication
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"drug": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Antineoplastic drug/medication administered to the patient",
"title": "Antineoplastic Drug",
"x-expanded": false,
"x-terminology": "AntineoplasticAgent"
},
"route": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Drug administration route",
"title": "Route",
"x-expanded": false,
"x-terminology": "DosageRoute"
},
"usedOfflabel": {
"description": "Indicates whether a medication was used off-label at the time of administration",
"title": "Off-label use",
"type": "boolean",
"x-expanded": false
},
"withinSoc": {
"description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
"title": "Within SOC",
"type": "boolean",
"x-expanded": false
},
"dosageMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage - Mass concentration",
"x-default-unit": "g/l",
"x-expanded": false,
"x-measure": "MassConcentration"
},
"dosageMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage - Fixed Mass",
"x-default-unit": "g",
"x-expanded": false,
"x-measure": "Mass"
},
"dosageVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage - Volume",
"x-default-unit": "l",
"x-expanded": false,
"x-measure": "Volume"
},
"dosageMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage - Mass per body surface",
"x-default-unit": "g/square_meter",
"x-expanded": false,
"x-measure": "MassPerArea"
},
"dosageRateMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage rate - Mass concentration",
"x-default-unit": "g/l/s",
"x-expanded": false,
"x-measure": "MassConcentrationPerTime"
},
"dosageRateMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage rate - Fixed Mass",
"x-default-unit": "g/s",
"x-expanded": false,
"x-measure": "MassPerTime"
},
"dosageRateVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage rate - Volume",
"x-default-unit": "l/s",
"x-expanded": false,
"x-measure": "VolumePerTime"
},
"dosageRateMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage rate - Mass per body surface",
"x-default-unit": "g/square_meter/s",
"x-expanded": false,
"x-measure": "MassPerAreaPerTime"
}
},
"required": [
"drug"
],
"title": "SystemicTherapyMedicationCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}¶
Delete Systemic Therapy Medication
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events¶
Get All Systemic Therapy Medication History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
medicationId |
path | string | No | ||
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
systemicTherapyId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events/{eventId}¶
Get Systemic Therapy Medication History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events/{eventId}/reversion¶
Revert Systemic Therapy Medication To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Surgeries¶
GET /api/v1/surgeries¶
Get All Surgeries Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
bodysite |
query | string | No | Anatomical location - Filter for a matching concept code | |
bodysite.anyOf |
query | array | No | Anatomical location - Filter for a matching set of concept codes | |
bodysite.descendantsOf |
query | string | No | Anatomical location - Filter for all child concepts of a given concepts code | |
bodysite.exists |
query | boolean | No | Anatomical location - Filter for entries with a value | |
bodysite.not |
query | string | No | Anatomical location - Filter for a mismatching concept code | |
bodysite.not.anyOf |
query | array | No | Anatomical location - Filter for a mismmatching set of concept codes | |
bodysite.not.exists |
query | boolean | No | Anatomical location - Filter for entries without a value | |
bodysiteLaterality |
query | string | No | Anatomical location laterality - Filter for a matching concept code | |
bodysiteLaterality.anyOf |
query | array | No | Anatomical location laterality - Filter for a matching set of concept codes | |
bodysiteLaterality.descendantsOf |
query | string | No | Anatomical location laterality - Filter for all child concepts of a given concepts code | |
bodysiteLaterality.exists |
query | boolean | No | Anatomical location laterality - Filter for entries with a value | |
bodysiteLaterality.not |
query | string | No | Anatomical location laterality - Filter for a mismatching concept code | |
bodysiteLaterality.not.anyOf |
query | array | No | Anatomical location laterality - Filter for a mismmatching set of concept codes | |
bodysiteLaterality.not.exists |
query | boolean | No | Anatomical location laterality - Filter for entries without a value | |
bodysiteQualifier |
query | string | No | Anatomical location qualifier - Filter for a matching concept code | |
bodysiteQualifier.anyOf |
query | array | No | Anatomical location qualifier - Filter for a matching set of concept codes | |
bodysiteQualifier.descendantsOf |
query | string | No | Anatomical location qualifier - Filter for all child concepts of a given concepts code | |
bodysiteQualifier.exists |
query | boolean | No | Anatomical location qualifier - Filter for entries with a value | |
bodysiteQualifier.not |
query | string | No | Anatomical location qualifier - Filter for a mismatching concept code | |
bodysiteQualifier.not.anyOf |
query | array | No | Anatomical location qualifier - Filter for a mismmatching set of concept codes | |
bodysiteQualifier.not.exists |
query | boolean | No | Anatomical location qualifier - Filter for entries without a value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
intent |
query | None | No | Intent - Filter for single value choice | |
intent.anyOf |
query | array | No | Intent - ('Filter for excluding a subset of value choices',) | |
intent.not |
query | None | No | Intent - ('Filter for all but a single value choice',) | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
outcome |
query | string | No | Outcome - Filter for a matching concept code | |
outcome.anyOf |
query | array | No | Outcome - Filter for a matching set of concept codes | |
outcome.descendantsOf |
query | string | No | Outcome - Filter for all child concepts of a given concepts code | |
outcome.exists |
query | boolean | No | Outcome - Filter for entries with a value | |
outcome.not |
query | string | No | Outcome - Filter for a mismatching concept code | |
outcome.not.anyOf |
query | array | No | Outcome - Filter for a mismmatching set of concept codes | |
outcome.not.exists |
query | boolean | No | Outcome - Filter for entries without a value | |
procedure |
query | string | No | Surgical procedure - Filter for a matching concept code | |
procedure.anyOf |
query | array | No | Surgical procedure - Filter for a matching set of concept codes | |
procedure.descendantsOf |
query | string | No | Surgical procedure - Filter for all child concepts of a given concepts code | |
procedure.not |
query | string | No | Surgical procedure - Filter for a mismatching concept code | |
procedure.not.anyOf |
query | array | No | Surgical procedure - Filter for a mismmatching set of concept codes | |
targetedEntitiesIds |
query | string | No | Targeted neoplastic entities - Filter for full text matches | |
targetedEntitiesIds.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference matches the query | |
targetedEntitiesIds.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries starting with the text | |
targetedEntitiesIds.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text matches | |
targetedEntitiesIds.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries ending with the text | |
targetedEntitiesIds.not |
query | string | No | Targeted neoplastic entities - Filter for full text mismatches | |
targetedEntitiesIds.not.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query | |
targetedEntitiesIds.not.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not starting with the text | |
targetedEntitiesIds.not.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text mismatches | |
targetedEntitiesIds.not.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not ending with the text | |
therapyLineId |
query | string | No | Therapy line - Filter for reference matches | |
therapyLineId.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference matches the query | |
therapyLineId.beginsWith |
query | string | No | Therapy line - Filter for entries starting with the text | |
therapyLineId.contains |
query | string | No | Therapy line - Filter for partial text matches | |
therapyLineId.endsWith |
query | string | No | Therapy line - Filter for entries ending with the text | |
therapyLineId.exists |
query | boolean | No | Therapy line - Filter for entries with a value | |
therapyLineId.not |
query | string | No | Therapy line - Filter for reference mismatches | |
therapyLineId.not.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference mismatches the query | |
therapyLineId.not.beginsWith |
query | string | No | Therapy line - Filter for entries not starting with the text | |
therapyLineId.not.contains |
query | string | No | Therapy line - Filter for partial text mismatches | |
therapyLineId.not.endsWith |
query | string | No | Therapy line - Filter for entries not ending with the text | |
therapyLineId.not.exists |
query | boolean | No | Therapy line - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "304a5edc-ba53-4d31-84b1-106cb617d829",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e532a854-3aca-4505-8592-d85b6f2c478d",
"date": "2022-04-13",
"procedure": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "1e1adf9f-0d96-4b8e-bf30-fc066495ff55",
"targetedEntitiesIds": [
"737c60c9-9972-42e5-9676-4002e5f502d1"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/surgeries¶
Create Surgery
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0cd22756-e8b8-47ee-ac91-0a3af92e15e8",
"date": "2022-04-13",
"procedure": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "a1f09d17-11f5-4528-aa0a-3f5f307bcda7",
"targetedEntitiesIds": [
"8cb8f041-f900-40c3-95c1-e6767d233bf1"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the surgical procedure",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the surgical procedure.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"procedure": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The specific surgical procedure that was performed",
"title": "Surgical procedure",
"x-expanded": false,
"x-terminology": "SurgicalProcedure"
},
"intent": {
"$ref": "#/components/schemas/SurgeryIntentChoices",
"description": "Therapeutic intent of the surgery",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"bodysite": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Anatomical location of the surgery",
"title": "Anatomical location",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"bodysiteQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the surgery",
"title": "Anatomical location qualifier",
"x-expanded": false,
"x-terminology": "BodyLocationQualifier"
},
"bodysiteLaterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality for the anatomical location of the surgery",
"title": "Anatomical location laterality",
"x-expanded": false,
"x-terminology": "LateralityQualifier"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The outcome of the surgery",
"title": "Outcome",
"x-expanded": false,
"x-terminology": "ProcedureOutcome"
},
"therapyLineId": {
"description": "Therapy line to which the surgery is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the surgery",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"date",
"procedure",
"intent"
],
"title": "SurgeryCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/surgeries/{surgeryId}¶
Get Surgery By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
surgeryId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"id": "5aa3bcf6-0064-405c-9ce4-d1a67ada09ea",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "795e7b94-79c8-4a82-84c4-ba5ad7e58b5e",
"date": "2022-04-13",
"procedure": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "c267931d-1e8a-485d-b355-eb0da439b9e0",
"targetedEntitiesIds": [
"6540d0a3-5e7e-4e32-84d7-cd235545551b"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the surgical procedure",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the surgical procedure.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"procedure": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The specific surgical procedure that was performed",
"title": "Surgical procedure",
"x-expanded": false,
"x-terminology": "SurgicalProcedure"
},
"intent": {
"$ref": "#/components/schemas/SurgeryIntentChoices",
"description": "Therapeutic intent of the surgery",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"bodysite": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Anatomical location of the surgery",
"title": "Anatomical location",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"bodysiteQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the surgery",
"title": "Anatomical location qualifier",
"x-expanded": false,
"x-terminology": "BodyLocationQualifier"
},
"bodysiteLaterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality for the anatomical location of the surgery",
"title": "Anatomical location laterality",
"x-expanded": false,
"x-terminology": "LateralityQualifier"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The outcome of the surgery",
"title": "Outcome",
"x-expanded": false,
"x-terminology": "ProcedureOutcome"
},
"therapyLineId": {
"description": "Therapy line to which the surgery is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the surgery",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"procedure",
"intent",
"description"
],
"title": "Surgery",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/surgeries/{surgeryId}¶
Update Surgery
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
surgeryId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b197e0da-e89f-46a3-b859-62512334a142",
"date": "2022-04-13",
"procedure": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "93634020-ff00-4f8f-a526-b4738a40fe87",
"targetedEntitiesIds": [
"d80a20c7-898c-469a-aa5e-fd64dd96bf60"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the surgical procedure",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the surgical procedure.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"procedure": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The specific surgical procedure that was performed",
"title": "Surgical procedure",
"x-expanded": false,
"x-terminology": "SurgicalProcedure"
},
"intent": {
"$ref": "#/components/schemas/SurgeryIntentChoices",
"description": "Therapeutic intent of the surgery",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"bodysite": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Anatomical location of the surgery",
"title": "Anatomical location",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"bodysiteQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the surgery",
"title": "Anatomical location qualifier",
"x-expanded": false,
"x-terminology": "BodyLocationQualifier"
},
"bodysiteLaterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality for the anatomical location of the surgery",
"title": "Anatomical location laterality",
"x-expanded": false,
"x-terminology": "LateralityQualifier"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The outcome of the surgery",
"title": "Outcome",
"x-expanded": false,
"x-terminology": "ProcedureOutcome"
},
"therapyLineId": {
"description": "Therapy line to which the surgery is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the surgery",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"date",
"procedure",
"intent"
],
"title": "SurgeryCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/surgeries/{surgeryId}¶
Delete Surgery
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
surgeryId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/surgeries/{surgeryId}/history/events¶
Get All Surgery History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
surgeryId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/surgeries/{surgeryId}/history/events/{eventId}¶
Get Surgery History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
surgeryId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/surgeries/{surgeryId}/history/events/{eventId}/reversion¶
Revert Surgery To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
surgeryId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Radiotherapies¶
GET /api/v1/radiotherapies¶
Get All Radiotherapies Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
dosages.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
dosages.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
dosages.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
dosages.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
dosages.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
dosages.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
dosages.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
dosages.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
dosages.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
dosages.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
dosages.dose.between |
query | array | No | Total radiation dose - Filter for entries with values between two specified values (inclusive) | |
dosages.dose.equal |
query | number | No | Total radiation dose - Filter for entries with values exactly equal to the specified value | |
dosages.dose.exists |
query | boolean | No | Total radiation dose - Filter for entries with a value | |
dosages.dose.greaterThan |
query | number | No | Total radiation dose - Filter for entries with values greater than the specified value | |
dosages.dose.greaterThanOrEqual |
query | number | No | Total radiation dose - Filter for entries with values greater than or equal to the specified value | |
dosages.dose.lessThan |
query | number | No | Total radiation dose - Filter for entries with values less than the specified value | |
dosages.dose.lessThanOrEqual |
query | number | No | Total radiation dose - Filter for entries with values less than or equal to the specified value | |
dosages.dose.not.between |
query | array | No | Total radiation dose - Filter for entries with values between two specified values (inclusive) | |
dosages.dose.not.equal |
query | number | No | Total radiation dose - Filter for entries with values not equal to the specified value | |
dosages.dose.not.exists |
query | boolean | No | Total radiation dose - Filter for entries without a value | |
dosages.externalSource |
query | string | No | External data source - Filter for full text matches | |
dosages.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
dosages.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
dosages.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
dosages.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
dosages.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
dosages.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
dosages.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
dosages.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
dosages.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
dosages.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
dosages.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
dosages.fractions.between |
query | array | No | Total fractions - Filter for entries with values between two specified values (inclusive) | |
dosages.fractions.equal |
query | integer | No | Total fractions - Filter for entries with values exactly equal to the specified value | |
dosages.fractions.exists |
query | boolean | No | Total fractions - Filter for entries with a value | |
dosages.fractions.greaterThan |
query | integer | No | Total fractions - Filter for entries with values greater than the specified value | |
dosages.fractions.greaterThanOrEqual |
query | integer | No | Total fractions - Filter for entries with values greater than or equal to the specified value | |
dosages.fractions.lessThan |
query | integer | No | Total fractions - Filter for entries with values less than the specified value | |
dosages.fractions.lessThanOrEqual |
query | integer | No | Total fractions - Filter for entries with values less than or equal to the specified value | |
dosages.fractions.not.between |
query | array | No | Total fractions - Filter for entries with values between two specified values (inclusive) | |
dosages.fractions.not.equal |
query | integer | No | Total fractions - Filter for entries with values not equal to the specified value | |
dosages.fractions.not.exists |
query | boolean | No | Total fractions - Filter for entries without a value | |
dosages.id |
query | string | No | Id - Filter for full text matches | |
dosages.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
dosages.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
dosages.id.contains |
query | string | No | Id - Filter for partial text matches | |
dosages.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
dosages.id.not |
query | string | No | Id - Filter for full text mismatches | |
dosages.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
dosages.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
dosages.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
dosages.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
dosages.irradiatedVolume |
query | string | No | Irradiated volume - Filter for a matching concept code | |
dosages.irradiatedVolume.anyOf |
query | array | No | Irradiated volume - Filter for a matching set of concept codes | |
dosages.irradiatedVolume.descendantsOf |
query | string | No | Irradiated volume - Filter for all child concepts of a given concepts code | |
dosages.irradiatedVolume.not |
query | string | No | Irradiated volume - Filter for a mismatching concept code | |
dosages.irradiatedVolume.not.anyOf |
query | array | No | Irradiated volume - Filter for a mismmatching set of concept codes | |
dosages.irradiatedVolumeMorphology |
query | string | No | Irradiated volume morphology - Filter for a matching concept code | |
dosages.irradiatedVolumeMorphology.anyOf |
query | array | No | Irradiated volume morphology - Filter for a matching set of concept codes | |
dosages.irradiatedVolumeMorphology.descendantsOf |
query | string | No | Irradiated volume morphology - Filter for all child concepts of a given concepts code | |
dosages.irradiatedVolumeMorphology.exists |
query | boolean | No | Irradiated volume morphology - Filter for entries with a value | |
dosages.irradiatedVolumeMorphology.not |
query | string | No | Irradiated volume morphology - Filter for a mismatching concept code | |
dosages.irradiatedVolumeMorphology.not.anyOf |
query | array | No | Irradiated volume morphology - Filter for a mismmatching set of concept codes | |
dosages.irradiatedVolumeMorphology.not.exists |
query | boolean | No | Irradiated volume morphology - Filter for entries without a value | |
dosages.irradiatedVolumeQualifier |
query | string | No | Irradiated volume qualifier - Filter for a matching concept code | |
dosages.irradiatedVolumeQualifier.anyOf |
query | array | No | Irradiated volume qualifier - Filter for a matching set of concept codes | |
dosages.irradiatedVolumeQualifier.descendantsOf |
query | string | No | Irradiated volume qualifier - Filter for all child concepts of a given concepts code | |
dosages.irradiatedVolumeQualifier.exists |
query | boolean | No | Irradiated volume qualifier - Filter for entries with a value | |
dosages.irradiatedVolumeQualifier.not |
query | string | No | Irradiated volume qualifier - Filter for a mismatching concept code | |
dosages.irradiatedVolumeQualifier.not.anyOf |
query | array | No | Irradiated volume qualifier - Filter for a mismmatching set of concept codes | |
dosages.irradiatedVolumeQualifier.not.exists |
query | boolean | No | Irradiated volume qualifier - Filter for entries without a value | |
dosages.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
dosages.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
dosages.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
dosages.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
dosages.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
dosages.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
dosages.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
dosages.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
dosages.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
dosages.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
duration.between |
query | array | No | Duration - Filter for entries with values between two specified values (inclusive) | |
duration.equal |
query | number | No | Duration - Filter for entries with values exactly equal to the specified value | |
duration.greaterThan |
query | number | No | Duration - Filter for entries with values greater than the specified value | |
duration.greaterThanOrEqual |
query | number | No | Duration - Filter for entries with values greater than or equal to the specified value | |
duration.lessThan |
query | number | No | Duration - Filter for entries with values less than the specified value | |
duration.lessThanOrEqual |
query | number | No | Duration - Filter for entries with values less than or equal to the specified value | |
duration.not.between |
query | array | No | Duration - Filter for entries with values between two specified values (inclusive) | |
duration.not.equal |
query | number | No | Duration - Filter for entries with values not equal to the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
intent |
query | None | No | Intent - Filter for single value choice | |
intent.anyOf |
query | array | No | Intent - ('Filter for excluding a subset of value choices',) | |
intent.not |
query | None | No | Intent - ('Filter for all but a single value choice',) | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
period.containedBy |
query | array | No | Treatment period - Filter for entries whose period are contined by the time period | |
period.contains |
query | array | No | Treatment period - Filter for entries containing the time period | |
period.not.containedBy |
query | array | No | Treatment period - Filter for entries whose period are not contined by the time period | |
period.not.contains |
query | array | No | Treatment period - Filter for entries not containing the time period | |
period.not.overlaps |
query | array | No | Treatment period - Filter for entries not overlapping with the time period | |
period.overlaps |
query | array | No | Treatment period - Filter for entries overlapping with the time period | |
sessions.between |
query | array | No | Total sessions - Filter for entries with values between two specified values (inclusive) | |
sessions.equal |
query | integer | No | Total sessions - Filter for entries with values exactly equal to the specified value | |
sessions.greaterThan |
query | integer | No | Total sessions - Filter for entries with values greater than the specified value | |
sessions.greaterThanOrEqual |
query | integer | No | Total sessions - Filter for entries with values greater than or equal to the specified value | |
sessions.lessThan |
query | integer | No | Total sessions - Filter for entries with values less than the specified value | |
sessions.lessThanOrEqual |
query | integer | No | Total sessions - Filter for entries with values less than or equal to the specified value | |
sessions.not.between |
query | array | No | Total sessions - Filter for entries with values between two specified values (inclusive) | |
sessions.not.equal |
query | integer | No | Total sessions - Filter for entries with values not equal to the specified value | |
settings.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
settings.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
settings.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
settings.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
settings.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
settings.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
settings.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
settings.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
settings.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
settings.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
settings.externalSource |
query | string | No | External data source - Filter for full text matches | |
settings.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
settings.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
settings.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
settings.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
settings.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
settings.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
settings.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
settings.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
settings.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
settings.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
settings.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
settings.id |
query | string | No | Id - Filter for full text matches | |
settings.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
settings.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
settings.id.contains |
query | string | No | Id - Filter for partial text matches | |
settings.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
settings.id.not |
query | string | No | Id - Filter for full text mismatches | |
settings.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
settings.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
settings.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
settings.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
settings.modality |
query | string | No | Modality - Filter for a matching concept code | |
settings.modality.anyOf |
query | array | No | Modality - Filter for a matching set of concept codes | |
settings.modality.descendantsOf |
query | string | No | Modality - Filter for all child concepts of a given concepts code | |
settings.modality.not |
query | string | No | Modality - Filter for a mismatching concept code | |
settings.modality.not.anyOf |
query | array | No | Modality - Filter for a mismmatching set of concept codes | |
settings.technique |
query | string | No | Technique - Filter for a matching concept code | |
settings.technique.anyOf |
query | array | No | Technique - Filter for a matching set of concept codes | |
settings.technique.descendantsOf |
query | string | No | Technique - Filter for all child concepts of a given concepts code | |
settings.technique.not |
query | string | No | Technique - Filter for a mismatching concept code | |
settings.technique.not.anyOf |
query | array | No | Technique - Filter for a mismmatching set of concept codes | |
settings.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
settings.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
settings.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
settings.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
settings.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
settings.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
settings.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
settings.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
settings.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
settings.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
targetedEntitiesIds |
query | string | No | Targeted neoplastic entities - Filter for full text matches | |
targetedEntitiesIds.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference matches the query | |
targetedEntitiesIds.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries starting with the text | |
targetedEntitiesIds.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text matches | |
targetedEntitiesIds.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries ending with the text | |
targetedEntitiesIds.not |
query | string | No | Targeted neoplastic entities - Filter for full text mismatches | |
targetedEntitiesIds.not.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query | |
targetedEntitiesIds.not.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not starting with the text | |
targetedEntitiesIds.not.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text mismatches | |
targetedEntitiesIds.not.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not ending with the text | |
terminationReason |
query | string | No | Termination reason - Filter for a matching concept code | |
terminationReason.anyOf |
query | array | No | Termination reason - Filter for a matching set of concept codes | |
terminationReason.descendantsOf |
query | string | No | Termination reason - Filter for all child concepts of a given concepts code | |
terminationReason.exists |
query | boolean | No | Termination reason - Filter for entries with a value | |
terminationReason.not |
query | string | No | Termination reason - Filter for a mismatching concept code | |
terminationReason.not.anyOf |
query | array | No | Termination reason - Filter for a mismmatching set of concept codes | |
terminationReason.not.exists |
query | boolean | No | Termination reason - Filter for entries without a value | |
therapyLineId |
query | string | No | Therapy line - Filter for reference matches | |
therapyLineId.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference matches the query | |
therapyLineId.beginsWith |
query | string | No | Therapy line - Filter for entries starting with the text | |
therapyLineId.contains |
query | string | No | Therapy line - Filter for partial text matches | |
therapyLineId.endsWith |
query | string | No | Therapy line - Filter for entries ending with the text | |
therapyLineId.exists |
query | boolean | No | Therapy line - Filter for entries with a value | |
therapyLineId.not |
query | string | No | Therapy line - Filter for reference mismatches | |
therapyLineId.not.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference mismatches the query | |
therapyLineId.not.beginsWith |
query | string | No | Therapy line - Filter for entries not starting with the text | |
therapyLineId.not.contains |
query | string | No | Therapy line - Filter for partial text mismatches | |
therapyLineId.not.endsWith |
query | string | No | Therapy line - Filter for entries not ending with the text | |
therapyLineId.not.exists |
query | boolean | No | Therapy line - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"duration": {
"value": 10.12,
"unit": "string"
},
"dosages": [
{
"id": "fe16c7c6-f7ce-4bef-a2e4-7088c7094cc5",
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"settings": [
{
"id": "eb5feeac-0df8-4e35-8e2d-979d87e9350a",
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "e87a270b-a857-4e18-9041-afc4df64e731",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fdf88262-1b6f-43ea-9dcd-8844e842c9a2",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "547b0f72-fb8f-4dcb-8359-44e5298abb4d",
"targetedEntitiesIds": [
"08cc2402-d937-4faa-b7d6-50a12c7a493f"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/radiotherapies¶
Create Radiotherapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "44063a46-6dd1-4439-8d41-b631f67d3860",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "2ab26868-1fea-4e04-8277-97d4734c1e27",
"targetedEntitiesIds": [
"4fdaf46e-a4cc-4e9f-9386-b6e9246cf2cb"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the radiotherapy",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
"title": "Treatment period",
"x-expanded": false
},
"sessions": {
"description": "The total number of radiotherapy sessions over the treatment period.",
"title": "Total sessions",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/RadiotherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the radiotherapy",
"title": "Termination reason",
"x-expanded": false,
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the radiotherapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the radiotherapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"period",
"sessions",
"intent"
],
"title": "RadiotherapyCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}¶
Get Radiotherapy By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
radiotherapyId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"duration": {
"value": 10.12,
"unit": "string"
},
"dosages": [
{
"id": "80ad65a3-b7fb-4174-ba6f-24b144da4bce",
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"settings": [
{
"id": "535bbf1a-c106-4a2d-b42d-c892ffddd61d",
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "d200391a-11dc-431f-b6c9-c6c62728ee59",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "dda4e385-0bbc-4426-b49c-82714e63dc73",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "8b7a8e2d-52fb-43e4-b786-222b4258509a",
"targetedEntitiesIds": [
"00b067d1-4af3-499c-a167-15b1cc333a92"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"duration": {
"$ref": "#/components/schemas/Measure",
"description": "Duration of treatment",
"title": "Duration",
"x-measure": "Time"
},
"dosages": {
"description": "Radiation doses administered during the radiotherapy",
"items": {
"$ref": "#/components/schemas/RadiotherapyDosage"
},
"title": "Dosages",
"type": "array"
},
"settings": {
"description": "Settings of the radiotherapy irradiation procedure",
"items": {
"$ref": "#/components/schemas/RadiotherapySetting"
},
"title": "Settings",
"type": "array"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the radiotherapy",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
"title": "Treatment period",
"x-expanded": false
},
"sessions": {
"description": "The total number of radiotherapy sessions over the treatment period.",
"title": "Total sessions",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/RadiotherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the radiotherapy",
"title": "Termination reason",
"x-expanded": false,
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the radiotherapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the radiotherapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"duration",
"dosages",
"settings",
"id",
"caseId",
"period",
"sessions",
"intent",
"description"
],
"title": "Radiotherapy",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/radiotherapies/{radiotherapyId}¶
Delete Radiotherapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/radiotherapies/{radiotherapyId}¶
Update Radiotherapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "3028f3ce-a411-49a9-91d8-a0553b479cf5",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "5bb32fe6-ce39-4fc6-8491-96d0d75e0a9b",
"targetedEntitiesIds": [
"1dc06e85-161f-475e-9032-c55495ae84b9"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who received the radiotherapy",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
"title": "Treatment period",
"x-expanded": false
},
"sessions": {
"description": "The total number of radiotherapy sessions over the treatment period.",
"title": "Total sessions",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/RadiotherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the radiotherapy",
"title": "Termination reason",
"x-expanded": false,
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the radiotherapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string",
"x-expanded": false
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the radiotherapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array",
"x-expanded": false
}
},
"required": [
"caseId",
"period",
"sessions",
"intent"
],
"title": "RadiotherapyCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/history/events¶
Get All Radiotherapy History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
radiotherapyId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/history/events/{eventId}¶
Get Radiotherapy History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
radiotherapyId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/radiotherapies/{radiotherapyId}/history/events/{eventId}/reversion¶
Revert Radiotherapy To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
radiotherapyId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/dosages¶
Get Radiotherapy Dosages Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Response 200 OK
[
{
"id": "d790f0de-54eb-45cf-94ae-d66ff8dc8b93",
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/radiotherapies/{radiotherapyId}/dosages¶
Create Radiotherapy Dosage
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"fractions": {
"description": "The total number of radiotherapy fractions delivered over the treatment period.",
"title": "Total fractions",
"type": "integer",
"x-expanded": false
},
"dose": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Total radiation dose delivered over the full radiotherapy course",
"title": "Total radiation dose",
"x-default-unit": "Gy",
"x-expanded": false,
"x-measure": "RadiationDose"
},
"irradiatedVolume": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the irradiated volume",
"title": "Irradiated volume",
"x-expanded": false,
"x-terminology": "RadiotherapyTreatmentLocation"
},
"irradiatedVolumeMorphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the anatomical location of the irradiated volume",
"title": "Irradiated volume morphology",
"x-expanded": false,
"x-terminology": "RadiotherapyVolumeType"
},
"irradiatedVolumeQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the irradiated volume",
"title": "Irradiated volume qualifier",
"x-expanded": false,
"x-terminology": "RadiotherapyTreatmentLocationQualifier"
}
},
"required": [
"irradiatedVolume"
],
"title": "RadiotherapyDosageCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}¶
Get Radiotherapy Dosage By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
radiotherapyId |
path | string | No |
Response 200 OK
{
"id": "5d23fd2b-22c6-4834-a872-caa76525abb2",
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"fractions": {
"description": "The total number of radiotherapy fractions delivered over the treatment period.",
"title": "Total fractions",
"type": "integer",
"x-expanded": false
},
"dose": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Total radiation dose delivered over the full radiotherapy course",
"title": "Total radiation dose",
"x-default-unit": "Gy",
"x-expanded": false,
"x-measure": "RadiationDose"
},
"irradiatedVolume": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the irradiated volume",
"title": "Irradiated volume",
"x-expanded": false,
"x-terminology": "RadiotherapyTreatmentLocation"
},
"irradiatedVolumeMorphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the anatomical location of the irradiated volume",
"title": "Irradiated volume morphology",
"x-expanded": false,
"x-terminology": "RadiotherapyVolumeType"
},
"irradiatedVolumeQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the irradiated volume",
"title": "Irradiated volume qualifier",
"x-expanded": false,
"x-terminology": "RadiotherapyTreatmentLocationQualifier"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"irradiatedVolume",
"description"
],
"title": "RadiotherapyDosage",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}¶
Update Radiotherapy Dosage
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
radiotherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"fractions": {
"description": "The total number of radiotherapy fractions delivered over the treatment period.",
"title": "Total fractions",
"type": "integer",
"x-expanded": false
},
"dose": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Total radiation dose delivered over the full radiotherapy course",
"title": "Total radiation dose",
"x-default-unit": "Gy",
"x-expanded": false,
"x-measure": "RadiationDose"
},
"irradiatedVolume": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the irradiated volume",
"title": "Irradiated volume",
"x-expanded": false,
"x-terminology": "RadiotherapyTreatmentLocation"
},
"irradiatedVolumeMorphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the anatomical location of the irradiated volume",
"title": "Irradiated volume morphology",
"x-expanded": false,
"x-terminology": "RadiotherapyVolumeType"
},
"irradiatedVolumeQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the irradiated volume",
"title": "Irradiated volume qualifier",
"x-expanded": false,
"x-terminology": "RadiotherapyTreatmentLocationQualifier"
}
},
"required": [
"irradiatedVolume"
],
"title": "RadiotherapyDosageCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}¶
Delete Radiotherapy Dosage
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
radiotherapyId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events¶
Get All Radiotherapy Dosage History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
radiotherapyId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events/{eventId}¶
Get Radiotherapy Dosage History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
eventId |
path | string | No | ||
radiotherapyId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events/{eventId}/reversion¶
Revert Radiotherapy Dosage To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
eventId |
path | string | No | ||
radiotherapyId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/settings¶
Get Radiotherapy Settings Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Response 200 OK
[
{
"id": "58e98e90-9bae-4b0a-91df-45a512c0bd09",
"externalSource": "string",
"externalSourceId": "string",
"modality": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"technique": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/radiotherapies/{radiotherapyId}/settings¶
Create Radiotherapy Setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"modality": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"technique": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"modality": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Modality of external beam or brachytherapy radiation procedures",
"title": "Modality",
"x-expanded": false,
"x-terminology": "RadiotherapyModality"
},
"technique": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Technique of external beam or brachytherapy radiation procedures",
"title": "Technique",
"x-expanded": false,
"x-terminology": "RadiotherapyTechnique"
}
},
"required": [
"modality",
"technique"
],
"title": "RadiotherapySettingCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}¶
Get Radiotherapy Setting By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Response 200 OK
{
"id": "d4f7c801-85d4-4306-aac8-3bd610676471",
"externalSource": "string",
"externalSourceId": "string",
"modality": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"technique": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"modality": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Modality of external beam or brachytherapy radiation procedures",
"title": "Modality",
"x-expanded": false,
"x-terminology": "RadiotherapyModality"
},
"technique": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Technique of external beam or brachytherapy radiation procedures",
"title": "Technique",
"x-expanded": false,
"x-terminology": "RadiotherapyTechnique"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"modality",
"technique",
"description"
],
"title": "RadiotherapySetting",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}¶
Update Radiotherapy Setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"modality": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"technique": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"modality": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Modality of external beam or brachytherapy radiation procedures",
"title": "Modality",
"x-expanded": false,
"x-terminology": "RadiotherapyModality"
},
"technique": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Technique of external beam or brachytherapy radiation procedures",
"title": "Technique",
"x-expanded": false,
"x-terminology": "RadiotherapyTechnique"
}
},
"required": [
"modality",
"technique"
],
"title": "RadiotherapySettingCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}¶
Delete Radiotherapy Setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events¶
Get All Radiotherapy Setting History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events/{eventId}¶
Get Radiotherapy Setting History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events/{eventId}/reversion¶
Revert Radiotherapy Setting To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Therapy Lines¶
GET /api/v1/therapy-lines¶
Get All Therapy Lines Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
intent |
query | None | No | Intent - Filter for single value choice | |
intent.anyOf |
query | array | No | Intent - ('Filter for excluding a subset of value choices',) | |
intent.not |
query | None | No | Intent - ('Filter for all but a single value choice',) | |
label |
query | string | No | Label - Filter for full text matches | |
label.anyOf |
query | array | No | Label - Filter for entries where at least one reference matches the query | |
label.beginsWith |
query | string | No | Label - Filter for entries starting with the text | |
label.contains |
query | string | No | Label - Filter for partial text matches | |
label.endsWith |
query | string | No | Label - Filter for entries ending with the text | |
label.not |
query | string | No | Label - Filter for full text mismatches | |
label.not.anyOf |
query | array | No | Label - Filter for entries where at least one reference mismatches the query | |
label.not.beginsWith |
query | string | No | Label - Filter for entries not starting with the text | |
label.not.contains |
query | string | No | Label - Filter for partial text mismatches | |
label.not.endsWith |
query | string | No | Label - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
ordinal.between |
query | array | No | Line ordinal number - Filter for entries with values between two specified values (inclusive) | |
ordinal.equal |
query | integer | No | Line ordinal number - Filter for entries with values exactly equal to the specified value | |
ordinal.greaterThan |
query | integer | No | Line ordinal number - Filter for entries with values greater than the specified value | |
ordinal.greaterThanOrEqual |
query | integer | No | Line ordinal number - Filter for entries with values greater than or equal to the specified value | |
ordinal.lessThan |
query | integer | No | Line ordinal number - Filter for entries with values less than the specified value | |
ordinal.lessThanOrEqual |
query | integer | No | Line ordinal number - Filter for entries with values less than or equal to the specified value | |
ordinal.not.between |
query | array | No | Line ordinal number - Filter for entries with values between two specified values (inclusive) | |
ordinal.not.equal |
query | integer | No | Line ordinal number - Filter for entries with values not equal to the specified value | |
period.containedBy |
query | array | No | Period - Filter for entries whose period are contined by the time period | |
period.contains |
query | array | No | Period - Filter for entries containing the time period | |
period.exists |
query | boolean | No | Period - Filter for entries with a value | |
period.not.containedBy |
query | array | No | Period - Filter for entries whose period are not contined by the time period | |
period.not.contains |
query | array | No | Period - Filter for entries not containing the time period | |
period.not.exists |
query | boolean | No | Period - Filter for entries without a value | |
period.not.overlaps |
query | array | No | Period - Filter for entries not overlapping with the time period | |
period.overlaps |
query | array | No | Period - Filter for entries overlapping with the time period | |
progressionDate.after |
query | string | No | Begin of progression - Filter for entries with dates after the specified value | |
progressionDate.before |
query | string | No | Begin of progression - Filter for entries with dates before the specified value | |
progressionDate.between |
query | array | No | Begin of progression - Filter for entries with dates between two specified values (inclusive) | |
progressionDate.exists |
query | boolean | No | Begin of progression - Filter for entries with a value | |
progressionDate.not.between |
query | array | No | Begin of progression - Filter for entries with dates not between two specified values (inclusive) | |
progressionDate.not.exists |
query | boolean | No | Begin of progression - Filter for entries without a value | |
progressionDate.not.on |
query | string | No | Begin of progression - Filter for entries with dates not matching the specified value | |
progressionDate.on |
query | string | No | Begin of progression - Filter for entries with dates exactly matching the specified value | |
progressionDate.onOrAfter |
query | string | No | Begin of progression - Filter for entries with dates on or after the specified value | |
progressionDate.onOrBefore |
query | string | No | Begin of progression - Filter for entries with dates on or before the specified value | |
progressionFreeSurvival.between |
query | array | No | Progression-free survival in months - Filter for entries with values between two specified values (inclusive) | |
progressionFreeSurvival.equal |
query | number | No | Progression-free survival in months - Filter for entries with values exactly equal to the specified value | |
progressionFreeSurvival.exists |
query | boolean | No | Progression-free survival in months - Filter for entries with a value | |
progressionFreeSurvival.greaterThan |
query | number | No | Progression-free survival in months - Filter for entries with values greater than the specified value | |
progressionFreeSurvival.greaterThanOrEqual |
query | number | No | Progression-free survival in months - Filter for entries with values greater than or equal to the specified value | |
progressionFreeSurvival.lessThan |
query | number | No | Progression-free survival in months - Filter for entries with values less than the specified value | |
progressionFreeSurvival.lessThanOrEqual |
query | number | No | Progression-free survival in months - Filter for entries with values less than or equal to the specified value | |
progressionFreeSurvival.not.between |
query | array | No | Progression-free survival in months - Filter for entries with values between two specified values (inclusive) | |
progressionFreeSurvival.not.equal |
query | number | No | Progression-free survival in months - Filter for entries with values not equal to the specified value | |
progressionFreeSurvival.not.exists |
query | boolean | No | Progression-free survival in months - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12,
"id": "2bb5683a-ef1b-4267-ad7d-c1783285c254",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d38ead59-3b81-446a-8705-927b1d4a5100",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/therapy-lines¶
Create Therapy Line
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "539a087e-20a4-4fc9-bb14-8d44d2620d0f",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient to whom this therapy line is associated",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"ordinal": {
"description": "Number indicating the sequence in which this block of treatments were administered to the patient",
"title": "Line ordinal number",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/TherapyLineIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"progressionDate": {
"description": "Date at which progression was first detected, if applicable",
"format": "date",
"title": "Begin of progression",
"type": "string",
"x-expanded": false
}
},
"required": [
"caseId",
"ordinal",
"intent"
],
"title": "TherapyLineCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/therapy-lines/{therapyLineId}¶
Get Therapy Line By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
therapyLineId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12,
"id": "68b4a67d-c0c4-4f23-9091-17c29f618a41",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0795f4b5-e6c3-4652-8161-a86162f481da",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"period": {
"allOf": [
{
"$ref": "#/components/schemas/Period"
}
],
"description": "Time period of the therapy line",
"title": "Period"
},
"label": {
"description": "Label categorizing the therapy line",
"title": "Label",
"type": "string"
},
"progressionFreeSurvival": {
"description": "Progression-free survival (PFS) of the patient for the therapy line",
"title": "Progression-free survival in months",
"type": "number"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient to whom this therapy line is associated",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"ordinal": {
"description": "Number indicating the sequence in which this block of treatments were administered to the patient",
"title": "Line ordinal number",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/TherapyLineIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"progressionDate": {
"description": "Date at which progression was first detected, if applicable",
"format": "date",
"title": "Begin of progression",
"type": "string",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"label",
"id",
"caseId",
"ordinal",
"intent",
"description"
],
"title": "TherapyLine",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/therapy-lines/{therapyLineId}¶
Update Therapy Line
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
therapyLineId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "492c17bc-a451-41f9-83f4-1a00ab3b7e72",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient to whom this therapy line is associated",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"ordinal": {
"description": "Number indicating the sequence in which this block of treatments were administered to the patient",
"title": "Line ordinal number",
"type": "integer",
"x-expanded": false
},
"intent": {
"$ref": "#/components/schemas/TherapyLineIntentChoices",
"description": "Treatment intent of the system therapy",
"maxLength": 30,
"title": "Intent",
"x-expanded": false
},
"progressionDate": {
"description": "Date at which progression was first detected, if applicable",
"format": "date",
"title": "Begin of progression",
"type": "string",
"x-expanded": false
}
},
"required": [
"caseId",
"ordinal",
"intent"
],
"title": "TherapyLineCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/therapy-lines/{therapyLineId}¶
Delete Therapy Line
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
therapyLineId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/therapy-lines/{therapyLineId}/history/events¶
Get All Therapy Line History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
therapyLineId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/therapy-lines/{therapyLineId}/history/events/{eventId}¶
Get Therapy Line History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
therapyLineId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/therapy-lines/{therapyLineId}/history/events/{eventId}/reversion¶
Revert Therapy Line To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
therapyLineId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/therapy-lines/{caseId}/re-assignments¶
Get Reassigned Patient Case Therapy Lines
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No |
Response 200 OK
[
{
"anonymized": true,
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12,
"id": "9130d717-34c5-4e5d-a708-76d7d7ddf125",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0d479fec-db0c-4266-afba-024cf284bdca",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Adverse Events¶
GET /api/v1/adverse-events¶
Get All Adverse Events Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Event date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Event date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Event date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Event date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Event date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Event date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Event date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Event date - Filter for entries with dates on or before the specified value | |
dateResolved.after |
query | string | No | Date resolved - Filter for entries with dates after the specified value | |
dateResolved.before |
query | string | No | Date resolved - Filter for entries with dates before the specified value | |
dateResolved.between |
query | array | No | Date resolved - Filter for entries with dates between two specified values (inclusive) | |
dateResolved.exists |
query | boolean | No | Date resolved - Filter for entries with a value | |
dateResolved.not.between |
query | array | No | Date resolved - Filter for entries with dates not between two specified values (inclusive) | |
dateResolved.not.exists |
query | boolean | No | Date resolved - Filter for entries without a value | |
dateResolved.not.on |
query | string | No | Date resolved - Filter for entries with dates not matching the specified value | |
dateResolved.on |
query | string | No | Date resolved - Filter for entries with dates exactly matching the specified value | |
dateResolved.onOrAfter |
query | string | No | Date resolved - Filter for entries with dates on or after the specified value | |
dateResolved.onOrBefore |
query | string | No | Date resolved - Filter for entries with dates on or before the specified value | |
event |
query | string | No | Adverse event - Filter for a matching concept code | |
event.anyOf |
query | array | No | Adverse event - Filter for a matching set of concept codes | |
event.descendantsOf |
query | string | No | Adverse event - Filter for all child concepts of a given concepts code | |
event.not |
query | string | No | Adverse event - Filter for a mismatching concept code | |
event.not.anyOf |
query | array | No | Adverse event - Filter for a mismmatching set of concept codes | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
grade.between |
query | array | No | Grade - Filter for entries with values between two specified values (inclusive) | |
grade.equal |
query | integer | No | Grade - Filter for entries with values exactly equal to the specified value | |
grade.greaterThan |
query | integer | No | Grade - Filter for entries with values greater than the specified value | |
grade.greaterThanOrEqual |
query | integer | No | Grade - Filter for entries with values greater than or equal to the specified value | |
grade.lessThan |
query | integer | No | Grade - Filter for entries with values less than the specified value | |
grade.lessThanOrEqual |
query | integer | No | Grade - Filter for entries with values less than or equal to the specified value | |
grade.not.between |
query | array | No | Grade - Filter for entries with values between two specified values (inclusive) | |
grade.not.equal |
query | integer | No | Grade - Filter for entries with values not equal to the specified value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
mitigations.adjustment |
query | string | No | Treatment Adjustment - Filter for a matching concept code | |
mitigations.adjustment.anyOf |
query | array | No | Treatment Adjustment - Filter for a matching set of concept codes | |
mitigations.adjustment.descendantsOf |
query | string | No | Treatment Adjustment - Filter for all child concepts of a given concepts code | |
mitigations.adjustment.exists |
query | boolean | No | Treatment Adjustment - Filter for entries with a value | |
mitigations.adjustment.not |
query | string | No | Treatment Adjustment - Filter for a mismatching concept code | |
mitigations.adjustment.not.anyOf |
query | array | No | Treatment Adjustment - Filter for a mismmatching set of concept codes | |
mitigations.adjustment.not.exists |
query | boolean | No | Treatment Adjustment - Filter for entries without a value | |
mitigations.category |
query | None | No | Mitigation category - Filter for single value choice | |
mitigations.category.anyOf |
query | array | No | Mitigation category - ('Filter for excluding a subset of value choices',) | |
mitigations.category.not |
query | None | No | Mitigation category - ('Filter for all but a single value choice',) | |
mitigations.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
mitigations.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
mitigations.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
mitigations.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
mitigations.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
mitigations.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
mitigations.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
mitigations.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
mitigations.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
mitigations.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
mitigations.drug |
query | string | No | Pharmacological drug - Filter for a matching concept code | |
mitigations.drug.anyOf |
query | array | No | Pharmacological drug - Filter for a matching set of concept codes | |
mitigations.drug.descendantsOf |
query | string | No | Pharmacological drug - Filter for all child concepts of a given concepts code | |
mitigations.drug.exists |
query | boolean | No | Pharmacological drug - Filter for entries with a value | |
mitigations.drug.not |
query | string | No | Pharmacological drug - Filter for a mismatching concept code | |
mitigations.drug.not.anyOf |
query | array | No | Pharmacological drug - Filter for a mismmatching set of concept codes | |
mitigations.drug.not.exists |
query | boolean | No | Pharmacological drug - Filter for entries without a value | |
mitigations.externalSource |
query | string | No | External data source - Filter for full text matches | |
mitigations.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
mitigations.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
mitigations.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
mitigations.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
mitigations.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
mitigations.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
mitigations.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
mitigations.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
mitigations.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
mitigations.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
mitigations.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
mitigations.id |
query | string | No | Id - Filter for full text matches | |
mitigations.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
mitigations.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
mitigations.id.contains |
query | string | No | Id - Filter for partial text matches | |
mitigations.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
mitigations.id.not |
query | string | No | Id - Filter for full text mismatches | |
mitigations.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
mitigations.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
mitigations.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
mitigations.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
mitigations.management |
query | string | No | Management - Filter for a matching concept code | |
mitigations.management.anyOf |
query | array | No | Management - Filter for a matching set of concept codes | |
mitigations.management.descendantsOf |
query | string | No | Management - Filter for all child concepts of a given concepts code | |
mitigations.management.exists |
query | boolean | No | Management - Filter for entries with a value | |
mitigations.management.not |
query | string | No | Management - Filter for a mismatching concept code | |
mitigations.management.not.anyOf |
query | array | No | Management - Filter for a mismmatching set of concept codes | |
mitigations.management.not.exists |
query | boolean | No | Management - Filter for entries without a value | |
mitigations.procedure |
query | string | No | Procedure - Filter for a matching concept code | |
mitigations.procedure.anyOf |
query | array | No | Procedure - Filter for a matching set of concept codes | |
mitigations.procedure.descendantsOf |
query | string | No | Procedure - Filter for all child concepts of a given concepts code | |
mitigations.procedure.exists |
query | boolean | No | Procedure - Filter for entries with a value | |
mitigations.procedure.not |
query | string | No | Procedure - Filter for a mismatching concept code | |
mitigations.procedure.not.anyOf |
query | array | No | Procedure - Filter for a mismmatching set of concept codes | |
mitigations.procedure.not.exists |
query | boolean | No | Procedure - Filter for entries without a value | |
mitigations.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
mitigations.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
mitigations.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
mitigations.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
mitigations.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
mitigations.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
mitigations.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
mitigations.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
mitigations.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
mitigations.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
outcome |
query | None | No | Date resolved - Filter for single value choice | |
outcome.anyOf |
query | array | No | Date resolved - ('Filter for excluding a subset of value choices',) | |
outcome.not |
query | None | No | Date resolved - ('Filter for all but a single value choice',) | |
suspectedCauses.causality |
query | None | No | Causality - Filter for single value choice | |
suspectedCauses.causality.anyOf |
query | array | No | Causality - ('Filter for excluding a subset of value choices',) | |
suspectedCauses.causality.exists |
query | boolean | No | Causality - Filter for entries with a value | |
suspectedCauses.causality.not |
query | None | No | Causality - ('Filter for all but a single value choice',) | |
suspectedCauses.causality.not.exists |
query | boolean | No | Causality - Filter for entries without a value | |
suspectedCauses.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
suspectedCauses.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
suspectedCauses.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
suspectedCauses.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
suspectedCauses.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
suspectedCauses.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
suspectedCauses.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
suspectedCauses.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
suspectedCauses.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
suspectedCauses.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
suspectedCauses.externalSource |
query | string | No | External data source - Filter for full text matches | |
suspectedCauses.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
suspectedCauses.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
suspectedCauses.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
suspectedCauses.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
suspectedCauses.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
suspectedCauses.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
suspectedCauses.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
suspectedCauses.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
suspectedCauses.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
suspectedCauses.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
suspectedCauses.id |
query | string | No | Id - Filter for full text matches | |
suspectedCauses.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
suspectedCauses.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
suspectedCauses.id.contains |
query | string | No | Id - Filter for partial text matches | |
suspectedCauses.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
suspectedCauses.id.not |
query | string | No | Id - Filter for full text mismatches | |
suspectedCauses.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
suspectedCauses.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
suspectedCauses.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
suspectedCauses.medicationId |
query | string | No | Suspected systemic therapy medication - Filter for reference matches | |
suspectedCauses.medicationId.anyOf |
query | array | No | Suspected systemic therapy medication - Filter for entries where at least one reference matches the query | |
suspectedCauses.medicationId.beginsWith |
query | string | No | Suspected systemic therapy medication - Filter for entries starting with the text | |
suspectedCauses.medicationId.contains |
query | string | No | Suspected systemic therapy medication - Filter for partial text matches | |
suspectedCauses.medicationId.endsWith |
query | string | No | Suspected systemic therapy medication - Filter for entries ending with the text | |
suspectedCauses.medicationId.exists |
query | boolean | No | Suspected systemic therapy medication - Filter for entries with a value | |
suspectedCauses.medicationId.not |
query | string | No | Suspected systemic therapy medication - Filter for reference mismatches | |
suspectedCauses.medicationId.not.anyOf |
query | array | No | Suspected systemic therapy medication - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.medicationId.not.beginsWith |
query | string | No | Suspected systemic therapy medication - Filter for entries not starting with the text | |
suspectedCauses.medicationId.not.contains |
query | string | No | Suspected systemic therapy medication - Filter for partial text mismatches | |
suspectedCauses.medicationId.not.endsWith |
query | string | No | Suspected systemic therapy medication - Filter for entries not ending with the text | |
suspectedCauses.medicationId.not.exists |
query | boolean | No | Suspected systemic therapy medication - Filter for entries without a value | |
suspectedCauses.radiotherapyId |
query | string | No | Suspected radiotherapy - Filter for reference matches | |
suspectedCauses.radiotherapyId.anyOf |
query | array | No | Suspected radiotherapy - Filter for entries where at least one reference matches the query | |
suspectedCauses.radiotherapyId.beginsWith |
query | string | No | Suspected radiotherapy - Filter for entries starting with the text | |
suspectedCauses.radiotherapyId.contains |
query | string | No | Suspected radiotherapy - Filter for partial text matches | |
suspectedCauses.radiotherapyId.endsWith |
query | string | No | Suspected radiotherapy - Filter for entries ending with the text | |
suspectedCauses.radiotherapyId.exists |
query | boolean | No | Suspected radiotherapy - Filter for entries with a value | |
suspectedCauses.radiotherapyId.not |
query | string | No | Suspected radiotherapy - Filter for reference mismatches | |
suspectedCauses.radiotherapyId.not.anyOf |
query | array | No | Suspected radiotherapy - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.radiotherapyId.not.beginsWith |
query | string | No | Suspected radiotherapy - Filter for entries not starting with the text | |
suspectedCauses.radiotherapyId.not.contains |
query | string | No | Suspected radiotherapy - Filter for partial text mismatches | |
suspectedCauses.radiotherapyId.not.endsWith |
query | string | No | Suspected radiotherapy - Filter for entries not ending with the text | |
suspectedCauses.radiotherapyId.not.exists |
query | boolean | No | Suspected radiotherapy - Filter for entries without a value | |
suspectedCauses.surgeryId |
query | string | No | Suspected surgery - Filter for reference matches | |
suspectedCauses.surgeryId.anyOf |
query | array | No | Suspected surgery - Filter for entries where at least one reference matches the query | |
suspectedCauses.surgeryId.beginsWith |
query | string | No | Suspected surgery - Filter for entries starting with the text | |
suspectedCauses.surgeryId.contains |
query | string | No | Suspected surgery - Filter for partial text matches | |
suspectedCauses.surgeryId.endsWith |
query | string | No | Suspected surgery - Filter for entries ending with the text | |
suspectedCauses.surgeryId.exists |
query | boolean | No | Suspected surgery - Filter for entries with a value | |
suspectedCauses.surgeryId.not |
query | string | No | Suspected surgery - Filter for reference mismatches | |
suspectedCauses.surgeryId.not.anyOf |
query | array | No | Suspected surgery - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.surgeryId.not.beginsWith |
query | string | No | Suspected surgery - Filter for entries not starting with the text | |
suspectedCauses.surgeryId.not.contains |
query | string | No | Suspected surgery - Filter for partial text mismatches | |
suspectedCauses.surgeryId.not.endsWith |
query | string | No | Suspected surgery - Filter for entries not ending with the text | |
suspectedCauses.surgeryId.not.exists |
query | boolean | No | Suspected surgery - Filter for entries without a value | |
suspectedCauses.systemicTherapyId |
query | string | No | Suspected systemic therapy - Filter for reference matches | |
suspectedCauses.systemicTherapyId.anyOf |
query | array | No | Suspected systemic therapy - Filter for entries where at least one reference matches the query | |
suspectedCauses.systemicTherapyId.beginsWith |
query | string | No | Suspected systemic therapy - Filter for entries starting with the text | |
suspectedCauses.systemicTherapyId.contains |
query | string | No | Suspected systemic therapy - Filter for partial text matches | |
suspectedCauses.systemicTherapyId.endsWith |
query | string | No | Suspected systemic therapy - Filter for entries ending with the text | |
suspectedCauses.systemicTherapyId.exists |
query | boolean | No | Suspected systemic therapy - Filter for entries with a value | |
suspectedCauses.systemicTherapyId.not |
query | string | No | Suspected systemic therapy - Filter for reference mismatches | |
suspectedCauses.systemicTherapyId.not.anyOf |
query | array | No | Suspected systemic therapy - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.systemicTherapyId.not.beginsWith |
query | string | No | Suspected systemic therapy - Filter for entries not starting with the text | |
suspectedCauses.systemicTherapyId.not.contains |
query | string | No | Suspected systemic therapy - Filter for partial text mismatches | |
suspectedCauses.systemicTherapyId.not.endsWith |
query | string | No | Suspected systemic therapy - Filter for entries not ending with the text | |
suspectedCauses.systemicTherapyId.not.exists |
query | boolean | No | Suspected systemic therapy - Filter for entries without a value | |
suspectedCauses.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
suspectedCauses.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
suspectedCauses.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
suspectedCauses.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
suspectedCauses.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
suspectedCauses.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
suspectedCauses.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
suspectedCauses.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
suspectedCauses.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
suspectedCauses.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"suspectedCauses": [
{
"id": "b27ad722-6c1d-41c9-9265-95b897420033",
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "6d7c43a1-ad70-405b-828c-ee856584446d",
"medicationId": "1d093edc-b088-4c43-bb1c-625aac64d866",
"radiotherapyId": "2bdda6bc-d488-4bb4-9a42-f45cc0a51748",
"surgeryId": "fdcd3f27-35c3-40a4-aed6-774943659f91",
"causality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"mitigations": [
{
"id": "4895e755-7beb-4b34-8a74-67fb295620d0",
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "6c9fd64d-d23e-4a09-b033-0860a69e15a2",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5f414304-35b0-40c5-902a-bd7e3af2ab25",
"date": "2022-04-13",
"event": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/adverse-events¶
Create Adverse Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "cc6aec51-d6ed-472b-b8a0-9fe4cef06d1b",
"date": "2022-04-13",
"event": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who had the adverse event being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the adverse event ocurred.",
"format": "date",
"title": "Event date",
"type": "string",
"x-expanded": false
},
"event": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Classification of the adverse event using CTCAE criteria",
"title": "Adverse event",
"x-expanded": false,
"x-terminology": "AdverseEventTerm"
},
"grade": {
"description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
"title": "Grade",
"type": "integer",
"x-expanded": false
},
"outcome": {
"$ref": "#/components/schemas/AdverseEventOutcomeChoices",
"description": "The date when the adverse event ended or returned to baseline.",
"maxLength": 50,
"title": "Date resolved",
"x-expanded": false
},
"dateResolved": {
"description": "The date when the adverse event ended or returned to baseline.",
"format": "date",
"title": "Date resolved",
"type": "string",
"x-expanded": false
}
},
"required": [
"caseId",
"date",
"event",
"grade",
"outcome"
],
"title": "AdverseEventCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}¶
Get Adverse Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
Response 200 OK
{
"anonymized": true,
"suspectedCauses": [
{
"id": "88cb1c60-1cb7-424a-b2b1-0a01250eea0a",
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "a4a3fe0a-d7b3-429c-93a0-79cdf9905d9d",
"medicationId": "50fde4b7-cce9-4332-bbe5-c3a2d2aebe76",
"radiotherapyId": "abc4963c-5550-4851-bae9-d062856ac522",
"surgeryId": "c2ccb9da-81bf-4f33-bf8b-9f8c9cf9a1ce",
"causality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"mitigations": [
{
"id": "b2f66d24-8c22-4dfc-b1a2-0cb69d6484db",
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "dbd23f2b-1ef9-471f-9fa8-e331a7ffff56",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e9288e05-0232-4c50-8b0c-cd305661e520",
"date": "2022-04-13",
"event": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"suspectedCauses": {
"description": "Suspected causes of the adverse event",
"items": {
"$ref": "#/components/schemas/AdverseEventSuspectedCause"
},
"title": "Suspected causes",
"type": "array"
},
"mitigations": {
"description": "Mitigations of the adverse event",
"items": {
"$ref": "#/components/schemas/AdverseEventMitigation"
},
"title": "Mitigations",
"type": "array"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who had the adverse event being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the adverse event ocurred.",
"format": "date",
"title": "Event date",
"type": "string",
"x-expanded": false
},
"event": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Classification of the adverse event using CTCAE criteria",
"title": "Adverse event",
"x-expanded": false,
"x-terminology": "AdverseEventTerm"
},
"grade": {
"description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
"title": "Grade",
"type": "integer",
"x-expanded": false
},
"outcome": {
"$ref": "#/components/schemas/AdverseEventOutcomeChoices",
"description": "The date when the adverse event ended or returned to baseline.",
"maxLength": 50,
"title": "Date resolved",
"x-expanded": false
},
"dateResolved": {
"description": "The date when the adverse event ended or returned to baseline.",
"format": "date",
"title": "Date resolved",
"type": "string",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"suspectedCauses",
"mitigations",
"id",
"caseId",
"date",
"event",
"grade",
"outcome",
"description"
],
"title": "AdverseEvent",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/adverse-events/{adverseEventId}¶
Delete Adverse Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/adverse-events/{adverseEventId}¶
Update Adverse Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "8748a4f8-6281-4889-b7fb-8b53fd30775c",
"date": "2022-04-13",
"event": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who had the adverse event being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the adverse event ocurred.",
"format": "date",
"title": "Event date",
"type": "string",
"x-expanded": false
},
"event": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Classification of the adverse event using CTCAE criteria",
"title": "Adverse event",
"x-expanded": false,
"x-terminology": "AdverseEventTerm"
},
"grade": {
"description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
"title": "Grade",
"type": "integer",
"x-expanded": false
},
"outcome": {
"$ref": "#/components/schemas/AdverseEventOutcomeChoices",
"description": "The date when the adverse event ended or returned to baseline.",
"maxLength": 50,
"title": "Date resolved",
"x-expanded": false
},
"dateResolved": {
"description": "The date when the adverse event ended or returned to baseline.",
"format": "date",
"title": "Date resolved",
"type": "string",
"x-expanded": false
}
},
"required": [
"caseId",
"date",
"event",
"grade",
"outcome"
],
"title": "AdverseEventCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/history/events¶
Get All Adverse Event History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/history/events/{eventId}¶
Get Adverse Event History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
eventId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/adverse-events/{adverseEventId}/history/events/{eventId}/reversion¶
Revert Adverse Event To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
eventId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/suspected-causes¶
Get Adverse Event Suspected Causes Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Response 200 OK
[
{
"id": "989efd0b-7428-4d26-86f4-6b0958d7b2a9",
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "9ff42a6d-87df-4dcc-80cb-eab396bc7a1a",
"medicationId": "fc77309c-218d-49ba-843e-25ea1cae9d97",
"radiotherapyId": "6f7f7fbf-2143-4525-bc07-039e8501860f",
"surgeryId": "beeec56c-6c17-4730-9c9d-b0d757a24687",
"causality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/adverse-events/{adverseEventId}/suspected-causes¶
Create Adverse Event Suspected Cause
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "a2170926-4d56-48e8-b51b-52b691571f90",
"medicationId": "7b7924d2-fd23-4acd-aac3-d2e153945dc4",
"radiotherapyId": "7ed62b19-71d6-4a36-b34a-ade1f36a1f91",
"surgeryId": "983c5958-253d-4869-b620-85d80a4ac4d5",
"causality": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"systemicTherapyId": {
"description": "Systemic therapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy",
"type": "string",
"x-expanded": false
},
"medicationId": {
"description": "Systemic therapy medication suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy medication",
"type": "string",
"x-expanded": false
},
"radiotherapyId": {
"description": "Radiotherapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected radiotherapy",
"type": "string",
"x-expanded": false
},
"surgeryId": {
"description": "Surgery suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected surgery",
"type": "string",
"x-expanded": false
},
"causality": {
"allOf": [
{
"$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices",
"maxLength": 50
}
],
"description": "Assessment of the potential causality",
"title": "Causality",
"x-expanded": false
}
},
"title": "AdverseEventSuspectedCauseCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}¶
Get Adverse Event Suspected Cause By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No |
Response 200 OK
{
"id": "4d37193a-5df9-4ab7-b707-e1a19ef056b3",
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "2d9e321c-34ee-4e60-9299-7995855cf631",
"medicationId": "364cdc15-0447-4e7f-9fb3-5e7d188ac765",
"radiotherapyId": "5a3c6e6b-d223-4522-9aee-7518351fa92c",
"surgeryId": "f4b2f14e-c3d0-4e6f-a026-67edc403b936",
"causality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"systemicTherapyId": {
"description": "Systemic therapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy",
"type": "string",
"x-expanded": false
},
"medicationId": {
"description": "Systemic therapy medication suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy medication",
"type": "string",
"x-expanded": false
},
"radiotherapyId": {
"description": "Radiotherapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected radiotherapy",
"type": "string",
"x-expanded": false
},
"surgeryId": {
"description": "Surgery suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected surgery",
"type": "string",
"x-expanded": false
},
"causality": {
"allOf": [
{
"$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices",
"maxLength": 50
}
],
"description": "Assessment of the potential causality",
"title": "Causality",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"description"
],
"title": "AdverseEventSuspectedCause",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}¶
Update Adverse Event Suspected Cause
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "b1fbde37-6514-4cb7-ad6d-9add62b42c6f",
"medicationId": "28c980d1-dec3-4647-8b8c-e2a9f6e228ba",
"radiotherapyId": "c8b48777-10dd-4915-89cb-1b2aaaa2b69a",
"surgeryId": "cb4b7179-9714-488b-bac5-aa09e28e83fe",
"causality": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"systemicTherapyId": {
"description": "Systemic therapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy",
"type": "string",
"x-expanded": false
},
"medicationId": {
"description": "Systemic therapy medication suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy medication",
"type": "string",
"x-expanded": false
},
"radiotherapyId": {
"description": "Radiotherapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected radiotherapy",
"type": "string",
"x-expanded": false
},
"surgeryId": {
"description": "Surgery suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected surgery",
"type": "string",
"x-expanded": false
},
"causality": {
"allOf": [
{
"$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices",
"maxLength": 50
}
],
"description": "Assessment of the potential causality",
"title": "Causality",
"x-expanded": false
}
},
"title": "AdverseEventSuspectedCauseCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}¶
Delete Adverse Event Suspected Cause
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events¶
Get All Adverse Event Suspected Cause History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events/{eventId}¶
Get Adverse Event Suspected Cause History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No | ||
eventId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events/{eventId}/reversion¶
Revert Adverse Event Suspected Cause To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No | ||
eventId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/mitigations¶
Get Adverse Event Mitigations Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Response 200 OK
[
{
"id": "95810fa5-79fe-4229-b376-9c6382037a89",
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/adverse-events/{adverseEventId}/mitigations¶
Create Adverse Event Mitigation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"category": {
"$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
"description": "Type of mitigation employed",
"maxLength": 50,
"title": "Mitigation category",
"x-expanded": false
},
"adjustment": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
"title": "Treatment Adjustment",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationTreatmentAdjustment"
},
"drug": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
"title": "Pharmacological drug",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationDrug"
},
"procedure": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
"title": "Procedure",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationProcedure"
},
"management": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Management type of the adverse event mitigation",
"title": "Management",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationManagement"
}
},
"required": [
"category"
],
"title": "AdverseEventMitigationCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}¶
Get Adverse Event Mitigation By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
mitigationId |
path | string | No |
Response 200 OK
{
"id": "918cfeea-5574-4eb6-b037-17613582defe",
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"category": {
"$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
"description": "Type of mitigation employed",
"maxLength": 50,
"title": "Mitigation category",
"x-expanded": false
},
"adjustment": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
"title": "Treatment Adjustment",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationTreatmentAdjustment"
},
"drug": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
"title": "Pharmacological drug",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationDrug"
},
"procedure": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
"title": "Procedure",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationProcedure"
},
"management": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Management type of the adverse event mitigation",
"title": "Management",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationManagement"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"category",
"description"
],
"title": "AdverseEventMitigation",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}¶
Update Adverse Event Mitigation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
mitigationId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"category": {
"$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
"description": "Type of mitigation employed",
"maxLength": 50,
"title": "Mitigation category",
"x-expanded": false
},
"adjustment": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
"title": "Treatment Adjustment",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationTreatmentAdjustment"
},
"drug": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
"title": "Pharmacological drug",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationDrug"
},
"procedure": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
"title": "Procedure",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationProcedure"
},
"management": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Management type of the adverse event mitigation",
"title": "Management",
"x-expanded": false,
"x-terminology": "AdverseEventMitigationManagement"
}
},
"required": [
"category"
],
"title": "AdverseEventMitigationCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}¶
Delete Adverse Event Mitigation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
mitigationId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events¶
Get All Adverse Event Mitigation History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
limit |
query | integer | 10 | No | |
mitigationId |
path | string | No | ||
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events/{eventId}¶
Get Adverse Event Mitigation History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
eventId |
path | string | No | ||
mitigationId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events/{eventId}/reversion¶
Revert Adverse Event Mitigation To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
eventId |
path | string | No | ||
mitigationId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Treatment Responses¶
GET /api/v1/treatment-responses¶
Get All Treatment Responses Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
assessedBodysites |
query | string | No | Assessed anatomical location - Filter for a matching concept code | |
assessedBodysites.allOf |
query | array | No | Assessed anatomical location - Filter for entries matching all of the concepts | |
assessedBodysites.anyOf |
query | array | No | Assessed anatomical location - Filter for a matching set of concept codes | |
assessedBodysites.descendantsOf |
query | string | No | Assessed anatomical location - Filter for all child concepts of a given concepts code | |
assessedBodysites.exists |
query | boolean | No | Assessed anatomical location - Filter for entries with a value | |
assessedBodysites.not |
query | string | No | Assessed anatomical location - Filter for a mismatching concept code | |
assessedBodysites.not.allOf |
query | array | No | Assessed anatomical location - Filter for entries mismatching all of the concepts | |
assessedBodysites.not.anyOf |
query | array | No | Assessed anatomical location - Filter for a mismmatching set of concept codes | |
assessedBodysites.not.exists |
query | boolean | No | Assessed anatomical location - Filter for entries without a value | |
assessedEntitiesIds |
query | string | No | Assessed neoplastic entities - Filter for full text matches | |
assessedEntitiesIds.anyOf |
query | array | No | Assessed neoplastic entities - Filter for entries where at least one reference matches the query | |
assessedEntitiesIds.beginsWith |
query | string | No | Assessed neoplastic entities - Filter for entries starting with the text | |
assessedEntitiesIds.contains |
query | string | No | Assessed neoplastic entities - Filter for partial text matches | |
assessedEntitiesIds.endsWith |
query | string | No | Assessed neoplastic entities - Filter for entries ending with the text | |
assessedEntitiesIds.not |
query | string | No | Assessed neoplastic entities - Filter for full text mismatches | |
assessedEntitiesIds.not.anyOf |
query | array | No | Assessed neoplastic entities - Filter for entries where at least one reference mismatches the query | |
assessedEntitiesIds.not.beginsWith |
query | string | No | Assessed neoplastic entities - Filter for entries not starting with the text | |
assessedEntitiesIds.not.contains |
query | string | No | Assessed neoplastic entities - Filter for partial text mismatches | |
assessedEntitiesIds.not.endsWith |
query | string | No | Assessed neoplastic entities - Filter for entries not ending with the text | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
methodology |
query | string | No | Assessment method - Filter for a matching concept code | |
methodology.anyOf |
query | array | No | Assessment method - Filter for a matching set of concept codes | |
methodology.descendantsOf |
query | string | No | Assessment method - Filter for all child concepts of a given concepts code | |
methodology.not |
query | string | No | Assessment method - Filter for a mismatching concept code | |
methodology.not.anyOf |
query | array | No | Assessment method - Filter for a mismmatching set of concept codes | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
recist |
query | string | No | RECIST - Filter for a matching concept code | |
recist.anyOf |
query | array | No | RECIST - Filter for a matching set of concept codes | |
recist.descendantsOf |
query | string | No | RECIST - Filter for all child concepts of a given concepts code | |
recist.not |
query | string | No | RECIST - Filter for a mismatching concept code | |
recist.not.anyOf |
query | array | No | RECIST - Filter for a mismmatching set of concept codes | |
recistInterpreted |
query | boolean | No | RECIST Interpreted? - Filter for yes/no statement | |
recistInterpreted.exists |
query | boolean | No | RECIST Interpreted? - Filter for entries with a value | |
recistInterpreted.not.exists |
query | boolean | No | RECIST Interpreted? - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "462f47f7-cc0a-4fca-828b-9cf1a43b6307",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b2d5c37d-dfb1-4b7c-a62d-2fa3913acfe4",
"date": "2022-04-13",
"recist": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"204c6fc3-9b33-4663-a545-22c782ad1d56"
],
"assessedBodysites": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Schema of the response body
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/treatment-responses¶
Create Treatment Response
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "541c873d-d24b-45e0-ac92-9d4add144d83",
"date": "2022-04-13",
"recist": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"8d96b4a8-6430-422a-9e64-ab35aa0fdf13"
],
"assessedBodysites": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's treatment response is asseessed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the treatment response assessment",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"recist": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The classification of the treatment response according to RECIST",
"title": "RECIST",
"x-expanded": false,
"x-terminology": "CancerTreatmentResponse"
},
"recistInterpreted": {
"description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
"title": "RECIST Interpreted?",
"type": "boolean",
"x-expanded": false
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Method used to assess and classify the treatment response",
"title": "Assessment method",
"x-expanded": false,
"x-terminology": "CancerTreatmentResponseObservationMethod"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assesed for treatment response",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array",
"x-expanded": false
},
"assessedBodysites": {
"description": "Anatomical location assessed to determine the treatment response",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Assessed anatomical location",
"type": "array",
"x-expanded": false,
"x-terminology": "ObservationBodySite"
}
},
"required": [
"caseId",
"date",
"recist",
"methodology"
],
"title": "TreatmentResponseCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/treatment-responses/{treatmentRresponseId}¶
Get Treatment Response By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
treatmentRresponseId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"id": "f2414e16-af9c-4380-b8f2-42bcd0da70c9",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "57f97848-7ec9-4413-9cbf-5121cb881b8f",
"date": "2022-04-13",
"recist": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"870f6b8e-af7f-409e-8d85-a5c665c86f95"
],
"assessedBodysites": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's treatment response is asseessed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the treatment response assessment",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"recist": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The classification of the treatment response according to RECIST",
"title": "RECIST",
"x-expanded": false,
"x-terminology": "CancerTreatmentResponse"
},
"recistInterpreted": {
"description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
"title": "RECIST Interpreted?",
"type": "boolean",
"x-expanded": false
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Method used to assess and classify the treatment response",
"title": "Assessment method",
"x-expanded": false,
"x-terminology": "CancerTreatmentResponseObservationMethod"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assesed for treatment response",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array",
"x-expanded": false
},
"assessedBodysites": {
"description": "Anatomical location assessed to determine the treatment response",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Assessed anatomical location",
"type": "array",
"x-expanded": false,
"x-terminology": "ObservationBodySite"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"recist",
"methodology",
"description"
],
"title": "TreatmentResponse",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/treatment-responses/{treatmentRresponseId}¶
Update Treatment Response
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
treatmentRresponseId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0da3a0ad-6b96-4b5f-9e26-71bb6386437b",
"date": "2022-04-13",
"recist": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"fe18f30b-ac60-4cf7-bc89-d71f15760c4b"
],
"assessedBodysites": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's treatment response is asseessed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the treatment response assessment",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"recist": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The classification of the treatment response according to RECIST",
"title": "RECIST",
"x-expanded": false,
"x-terminology": "CancerTreatmentResponse"
},
"recistInterpreted": {
"description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
"title": "RECIST Interpreted?",
"type": "boolean",
"x-expanded": false
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Method used to assess and classify the treatment response",
"title": "Assessment method",
"x-expanded": false,
"x-terminology": "CancerTreatmentResponseObservationMethod"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assesed for treatment response",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array",
"x-expanded": false
},
"assessedBodysites": {
"description": "Anatomical location assessed to determine the treatment response",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Assessed anatomical location",
"type": "array",
"x-expanded": false,
"x-terminology": "ObservationBodySite"
}
},
"required": [
"caseId",
"date",
"recist",
"methodology"
],
"title": "TreatmentResponseCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/treatment-responses/{treatmentRresponseId}¶
Delete Treatment Response
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
treatmentRresponseId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/treatment-responses/{treatmentRresponseId}/history/events¶
Get All Treatment Response History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
treatmentRresponseId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/treatment-responses/{treatmentRresponseId}/history/events/{eventId}¶
Get Treatment Response History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
treatmentRresponseId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/treatment-responses/{treatmentRresponseId}/history/events/{eventId}/reversion¶
Revert Treatment Response To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
treatmentRresponseId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Tumor Boards¶
GET /api/v1/tumor-boards¶
Get All Tumor Boards Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
recommendations |
query | string | No | Recommendations - Filter for a matching concept code | |
recommendations.allOf |
query | array | No | Recommendations - Filter for entries matching all of the concepts | |
recommendations.anyOf |
query | array | No | Recommendations - Filter for a matching set of concept codes | |
recommendations.descendantsOf |
query | string | No | Recommendations - Filter for all child concepts of a given concepts code | |
recommendations.exists |
query | boolean | No | Recommendations - Filter for entries with a value | |
recommendations.not |
query | string | No | Recommendations - Filter for a mismatching concept code | |
recommendations.not.allOf |
query | array | No | Recommendations - Filter for entries mismatching all of the concepts | |
recommendations.not.anyOf |
query | array | No | Recommendations - Filter for a mismmatching set of concept codes | |
recommendations.not.exists |
query | boolean | No | Recommendations - Filter for entries without a value | |
relatedEntitiesIds |
query | string | No | Related neoplastic entities - Filter for full text matches | |
relatedEntitiesIds.anyOf |
query | array | No | Related neoplastic entities - Filter for entries where at least one reference matches the query | |
relatedEntitiesIds.beginsWith |
query | string | No | Related neoplastic entities - Filter for entries starting with the text | |
relatedEntitiesIds.contains |
query | string | No | Related neoplastic entities - Filter for partial text matches | |
relatedEntitiesIds.endsWith |
query | string | No | Related neoplastic entities - Filter for entries ending with the text | |
relatedEntitiesIds.not |
query | string | No | Related neoplastic entities - Filter for full text mismatches | |
relatedEntitiesIds.not.anyOf |
query | array | No | Related neoplastic entities - Filter for entries where at least one reference mismatches the query | |
relatedEntitiesIds.not.beginsWith |
query | string | No | Related neoplastic entities - Filter for entries not starting with the text | |
relatedEntitiesIds.not.contains |
query | string | No | Related neoplastic entities - Filter for partial text mismatches | |
relatedEntitiesIds.not.endsWith |
query | string | No | Related neoplastic entities - Filter for entries not ending with the text | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/tumor-boards¶
Create Tumor Board
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/tumor-boards/{tumorBoardId}¶
Get Tumor Board By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
tumorBoardId |
path | string | No |
Response 200 OK
Response 404 Not Found
PUT /api/v1/tumor-boards/{tumorBoardId}¶
Update Tumor Board
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorBoardId |
path | string | No |
Request body
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/tumor-boards/{tumorBoardId}¶
Delete Tumor Board
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorBoardId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/tumor-boards/{tumorBoardId}/history/events¶
Get All Tumor Board History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
tumorBoardId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/tumor-boards/{tumorBoardId}/history/events/{eventId}¶
Get Tumor Board History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
tumorBoardId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "Represents an audit/history event capturing changes in the system.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEvent",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/tumor-boards/{tumorBoardId}/history/events/{eventId}/reversion¶
Revert Tumor Board To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
tumorBoardId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations¶
Get Molecular Tumor Board Therapeutic Recommendations Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorBoardId |
path | string | No |
Response 200 OK
[
{
"id": "45179544-be3e-4e46-8f0b-3e1466aa210d",
"externalSource": "string",
"externalSourceId": "string",
"expectedEffect": null,
"clinicalTrial": "string",
"offLabelUse": true,
"withinSoc": true,
"drugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"supportingGenomicVariantsIds": [
"339e4d12-ac9f-46bf-b6ae-66e85047a50f"
],
"supportingGenomicSignaturesIds": [
"fadb68de-5b37-48c5-91c3-9ada51acbaf4"
],
"supportingTumorMarkersIds": [
"0f176a8b-cf0c-43a6-a57e-325dc7ec1b5d"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations¶
Create Molecular Tumor Board Therapeutic Recommendation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorBoardId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"expectedEffect": null,
"clinicalTrial": "string",
"offLabelUse": true,
"withinSoc": true,
"drugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"supportingGenomicVariantsIds": [
"58fc6728-57c2-4d4b-8e4d-8ff4a22c70c7"
],
"supportingGenomicSignaturesIds": [
"1fc20d98-c493-48eb-ae2c-882007a28e35"
],
"supportingTumorMarkersIds": [
"13b1c9f4-14b5-4752-8e2a-e9f23ab44954"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"expectedEffect": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the expected effect of the drug",
"title": "Expected medication action",
"x-expanded": false,
"x-terminology": "ExpectedDrugAction"
},
"clinicalTrial": {
"description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
"maxLength": 15,
"title": "Recommended clinical trial",
"type": "string",
"x-expanded": false
},
"offLabelUse": {
"description": "Whether the medication(s) recommended were off-label",
"title": "Off-label use",
"type": "boolean",
"x-expanded": false
},
"withinSoc": {
"description": "Whether the medication(s) recommended were within standard of care",
"title": "Within SOC",
"type": "boolean",
"x-expanded": false
},
"drugs": {
"description": "Drugs(s) being recommended",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Drug(s)",
"type": "array",
"x-expanded": false,
"x-terminology": "AntineoplasticAgent"
},
"supportingGenomicVariantsIds": {
"description": "Genomic variants that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic variants",
"type": "array",
"x-expanded": false
},
"supportingGenomicSignaturesIds": {
"description": "Genomic signatures that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic signatures",
"type": "array",
"x-expanded": false
},
"supportingTumorMarkersIds": {
"description": "Tumor markers that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting tumor markers",
"type": "array",
"x-expanded": false
}
},
"title": "MolecularTherapeuticRecommendationCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}¶
Get Molecular Tumor Board Therapeutic Recommendation By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Response 200 OK
{
"id": "c85f52bf-53ef-40f0-a403-1807a894d375",
"externalSource": "string",
"externalSourceId": "string",
"expectedEffect": null,
"clinicalTrial": "string",
"offLabelUse": true,
"withinSoc": true,
"drugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"supportingGenomicVariantsIds": [
"59decce4-3726-431d-9694-160b345abdc5"
],
"supportingGenomicSignaturesIds": [
"4c7c1e06-00d6-4d41-9cb8-69d3768c8e5c"
],
"supportingTumorMarkersIds": [
"6bf6a95f-4406-4026-a5ca-60b7fff88088"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"expectedEffect": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the expected effect of the drug",
"title": "Expected medication action",
"x-expanded": false,
"x-terminology": "ExpectedDrugAction"
},
"clinicalTrial": {
"description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
"maxLength": 15,
"title": "Recommended clinical trial",
"type": "string",
"x-expanded": false
},
"offLabelUse": {
"description": "Whether the medication(s) recommended were off-label",
"title": "Off-label use",
"type": "boolean",
"x-expanded": false
},
"withinSoc": {
"description": "Whether the medication(s) recommended were within standard of care",
"title": "Within SOC",
"type": "boolean",
"x-expanded": false
},
"drugs": {
"description": "Drugs(s) being recommended",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Drug(s)",
"type": "array",
"x-expanded": false,
"x-terminology": "AntineoplasticAgent"
},
"supportingGenomicVariantsIds": {
"description": "Genomic variants that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic variants",
"type": "array",
"x-expanded": false
},
"supportingGenomicSignaturesIds": {
"description": "Genomic signatures that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic signatures",
"type": "array",
"x-expanded": false
},
"supportingTumorMarkersIds": {
"description": "Tumor markers that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting tumor markers",
"type": "array",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"description"
],
"title": "MolecularTherapeuticRecommendation",
"type": "object"
}
Response 404 Not Found
PUT /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}¶
Update Molecular Tumor Board Therapeutic Recommendation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"expectedEffect": null,
"clinicalTrial": "string",
"offLabelUse": true,
"withinSoc": true,
"drugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"supportingGenomicVariantsIds": [
"caab89c9-5744-4fbf-8c3b-2834e8295dd9"
],
"supportingGenomicSignaturesIds": [
"30406c82-e7d4-4a2f-b3c1-9eacaf2c570f"
],
"supportingTumorMarkersIds": [
"fe99cb05-b7b4-409c-ada5-f059158ae21a"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"expectedEffect": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the expected effect of the drug",
"title": "Expected medication action",
"x-expanded": false,
"x-terminology": "ExpectedDrugAction"
},
"clinicalTrial": {
"description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
"maxLength": 15,
"title": "Recommended clinical trial",
"type": "string",
"x-expanded": false
},
"offLabelUse": {
"description": "Whether the medication(s) recommended were off-label",
"title": "Off-label use",
"type": "boolean",
"x-expanded": false
},
"withinSoc": {
"description": "Whether the medication(s) recommended were within standard of care",
"title": "Within SOC",
"type": "boolean",
"x-expanded": false
},
"drugs": {
"description": "Drugs(s) being recommended",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Drug(s)",
"type": "array",
"x-expanded": false,
"x-terminology": "AntineoplasticAgent"
},
"supportingGenomicVariantsIds": {
"description": "Genomic variants that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic variants",
"type": "array",
"x-expanded": false
},
"supportingGenomicSignaturesIds": {
"description": "Genomic signatures that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic signatures",
"type": "array",
"x-expanded": false
},
"supportingTumorMarkersIds": {
"description": "Tumor markers that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting tumor markers",
"type": "array",
"x-expanded": false
}
},
"title": "MolecularTherapeuticRecommendationCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}¶
Delete Molecular Tumor Board Therapeutic Recommendation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events¶
Get All Molecular Tumor Board Therapeutic History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events/{eventId}¶
Get Molecular Tumor Board Therapeutic History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "Represents an audit/history event capturing changes in the system.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEvent",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events/{eventId}/reversion¶
Revert Molecular Tumor Board Therapeutic To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Performance Status¶
GET /api/v1/performance-status¶
Get All Performance Status Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
ecogInterpretation |
query | string | No | ECOG Interpreation - Filter for a matching concept code | |
ecogInterpretation.anyOf |
query | array | No | ECOG Interpreation - Filter for a matching set of concept codes | |
ecogInterpretation.descendantsOf |
query | string | No | ECOG Interpreation - Filter for all child concepts of a given concepts code | |
ecogInterpretation.exists |
query | boolean | No | ECOG Interpreation - Filter for entries with a value | |
ecogInterpretation.not |
query | string | No | ECOG Interpreation - Filter for a mismatching concept code | |
ecogInterpretation.not.anyOf |
query | array | No | ECOG Interpreation - Filter for a mismmatching set of concept codes | |
ecogInterpretation.not.exists |
query | boolean | No | ECOG Interpreation - Filter for entries without a value | |
ecogScore.between |
query | array | No | ECOG Score - Filter for entries with values between two specified values (inclusive) | |
ecogScore.equal |
query | integer | No | ECOG Score - Filter for entries with values exactly equal to the specified value | |
ecogScore.exists |
query | boolean | No | ECOG Score - Filter for entries with a value | |
ecogScore.greaterThan |
query | integer | No | ECOG Score - Filter for entries with values greater than the specified value | |
ecogScore.greaterThanOrEqual |
query | integer | No | ECOG Score - Filter for entries with values greater than or equal to the specified value | |
ecogScore.lessThan |
query | integer | No | ECOG Score - Filter for entries with values less than the specified value | |
ecogScore.lessThanOrEqual |
query | integer | No | ECOG Score - Filter for entries with values less than or equal to the specified value | |
ecogScore.not.between |
query | array | No | ECOG Score - Filter for entries with values between two specified values (inclusive) | |
ecogScore.not.equal |
query | integer | No | ECOG Score - Filter for entries with values not equal to the specified value | |
ecogScore.not.exists |
query | boolean | No | ECOG Score - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
karnofskyInterpretation |
query | string | No | Karnofsky Interpreation - Filter for a matching concept code | |
karnofskyInterpretation.anyOf |
query | array | No | Karnofsky Interpreation - Filter for a matching set of concept codes | |
karnofskyInterpretation.descendantsOf |
query | string | No | Karnofsky Interpreation - Filter for all child concepts of a given concepts code | |
karnofskyInterpretation.exists |
query | boolean | No | Karnofsky Interpreation - Filter for entries with a value | |
karnofskyInterpretation.not |
query | string | No | Karnofsky Interpreation - Filter for a mismatching concept code | |
karnofskyInterpretation.not.anyOf |
query | array | No | Karnofsky Interpreation - Filter for a mismmatching set of concept codes | |
karnofskyInterpretation.not.exists |
query | boolean | No | Karnofsky Interpreation - Filter for entries without a value | |
karnofskyScore.between |
query | array | No | Karnofsky Score - Filter for entries with values between two specified values (inclusive) | |
karnofskyScore.equal |
query | integer | No | Karnofsky Score - Filter for entries with values exactly equal to the specified value | |
karnofskyScore.exists |
query | boolean | No | Karnofsky Score - Filter for entries with a value | |
karnofskyScore.greaterThan |
query | integer | No | Karnofsky Score - Filter for entries with values greater than the specified value | |
karnofskyScore.greaterThanOrEqual |
query | integer | No | Karnofsky Score - Filter for entries with values greater than or equal to the specified value | |
karnofskyScore.lessThan |
query | integer | No | Karnofsky Score - Filter for entries with values less than the specified value | |
karnofskyScore.lessThanOrEqual |
query | integer | No | Karnofsky Score - Filter for entries with values less than or equal to the specified value | |
karnofskyScore.not.between |
query | array | No | Karnofsky Score - Filter for entries with values between two specified values (inclusive) | |
karnofskyScore.not.equal |
query | integer | No | Karnofsky Score - Filter for entries with values not equal to the specified value | |
karnofskyScore.not.exists |
query | boolean | No | Karnofsky Score - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"ecogInterpretation": null,
"karnofskyInterpretation": null,
"id": "51ccdc5d-f149-47a2-a434-62af69c8ab73",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9da06399-a288-4028-be9c-553ee671fefc",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Schema of the response body
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/performance-status¶
Create Performance Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2184237c-014b-48a8-af93-0a5dee94fb6c",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's performance status is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the performance score was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"ecogScore": {
"description": "ECOG Performance Status Score",
"title": "ECOG Score",
"type": "integer",
"x-expanded": false
},
"karnofskyScore": {
"description": "Karnofsky Performance Status Score",
"title": "Karnofsky Score",
"type": "integer",
"x-expanded": false
}
},
"required": [
"caseId",
"date"
],
"title": "PerformanceStatusCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/performance-status/{performanceStatusId}¶
Get Performance Status By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
performanceStatusId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"ecogInterpretation": null,
"karnofskyInterpretation": null,
"id": "0eadfa69-2b09-401e-9548-77384871a052",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b1979b18-c5ca-418c-9a30-4016d39ad2b9",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"ecogInterpretation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Official interpretation of the ECOG score",
"title": "ECOG Interpreation",
"x-terminology": "ECOGPerformanceStatusInterpretation"
},
"karnofskyInterpretation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Official interpretation of the Karnofsky score",
"title": "Karnofsky Interpreation",
"x-terminology": "KarnofskyPerformanceStatusInterpretation"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's performance status is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the performance score was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"ecogScore": {
"description": "ECOG Performance Status Score",
"title": "ECOG Score",
"type": "integer",
"x-expanded": false
},
"karnofskyScore": {
"description": "Karnofsky Performance Status Score",
"title": "Karnofsky Score",
"type": "integer",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"description"
],
"title": "PerformanceStatus",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/performance-status/{performanceStatusId}¶
Update Performance Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
performanceStatusId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "436e9f7f-bc94-41ec-8110-ee7c47751caa",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's performance status is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the performance score was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"ecogScore": {
"description": "ECOG Performance Status Score",
"title": "ECOG Score",
"type": "integer",
"x-expanded": false
},
"karnofskyScore": {
"description": "Karnofsky Performance Status Score",
"title": "Karnofsky Score",
"type": "integer",
"x-expanded": false
}
},
"required": [
"caseId",
"date"
],
"title": "PerformanceStatusCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/performance-status/{performanceStatusId}¶
Delete Performance Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
performanceStatusId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/performance-status/{performanceStatusId}/history/events¶
Get All Performance Status History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
performanceStatusId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/performance-status/{performanceStatusId}/history/events/{eventId}¶
Get Performance Status History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
performanceStatusId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/performance-status/{performanceStatusId}/history/events/{eventId}/reversion¶
Revert Performance Status To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
performanceStatusId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Genomic Variants¶
GET /api/v1/genomic-variants¶
Get All Genomic Variants Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
alleleDepth.between |
query | array | No | Allele depth (reads) - Filter for entries with values between two specified values (inclusive) | |
alleleDepth.equal |
query | integer | No | Allele depth (reads) - Filter for entries with values exactly equal to the specified value | |
alleleDepth.exists |
query | boolean | No | Allele depth (reads) - Filter for entries with a value | |
alleleDepth.greaterThan |
query | integer | No | Allele depth (reads) - Filter for entries with values greater than the specified value | |
alleleDepth.greaterThanOrEqual |
query | integer | No | Allele depth (reads) - Filter for entries with values greater than or equal to the specified value | |
alleleDepth.lessThan |
query | integer | No | Allele depth (reads) - Filter for entries with values less than the specified value | |
alleleDepth.lessThanOrEqual |
query | integer | No | Allele depth (reads) - Filter for entries with values less than or equal to the specified value | |
alleleDepth.not.between |
query | array | No | Allele depth (reads) - Filter for entries with values between two specified values (inclusive) | |
alleleDepth.not.equal |
query | integer | No | Allele depth (reads) - Filter for entries with values not equal to the specified value | |
alleleDepth.not.exists |
query | boolean | No | Allele depth (reads) - Filter for entries without a value | |
alleleFrequency.between |
query | array | No | Allele frequency - Filter for entries with values between two specified values (inclusive) | |
alleleFrequency.equal |
query | number | No | Allele frequency - Filter for entries with values exactly equal to the specified value | |
alleleFrequency.exists |
query | boolean | No | Allele frequency - Filter for entries with a value | |
alleleFrequency.greaterThan |
query | number | No | Allele frequency - Filter for entries with values greater than the specified value | |
alleleFrequency.greaterThanOrEqual |
query | number | No | Allele frequency - Filter for entries with values greater than or equal to the specified value | |
alleleFrequency.lessThan |
query | number | No | Allele frequency - Filter for entries with values less than the specified value | |
alleleFrequency.lessThanOrEqual |
query | number | No | Allele frequency - Filter for entries with values less than or equal to the specified value | |
alleleFrequency.not.between |
query | array | No | Allele frequency - Filter for entries with values between two specified values (inclusive) | |
alleleFrequency.not.equal |
query | number | No | Allele frequency - Filter for entries with values not equal to the specified value | |
alleleFrequency.not.exists |
query | boolean | No | Allele frequency - Filter for entries without a value | |
analysisMethod |
query | string | No | Analysis method - Filter for a matching concept code | |
analysisMethod.anyOf |
query | array | No | Analysis method - Filter for a matching set of concept codes | |
analysisMethod.descendantsOf |
query | string | No | Analysis method - Filter for all child concepts of a given concepts code | |
analysisMethod.exists |
query | boolean | No | Analysis method - Filter for entries with a value | |
analysisMethod.not |
query | string | No | Analysis method - Filter for a mismatching concept code | |
analysisMethod.not.anyOf |
query | array | No | Analysis method - Filter for a mismmatching set of concept codes | |
analysisMethod.not.exists |
query | boolean | No | Analysis method - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
assessment |
query | None | No | Assessment - Filter for single value choice | |
assessment.anyOf |
query | array | No | Assessment - ('Filter for excluding a subset of value choices',) | |
assessment.exists |
query | boolean | No | Assessment - Filter for entries with a value | |
assessment.not |
query | None | No | Assessment - ('Filter for all but a single value choice',) | |
assessment.not.exists |
query | boolean | No | Assessment - Filter for entries without a value | |
assessmentDate.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
assessmentDate.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
assessmentDate.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
assessmentDate.exists |
query | boolean | No | Assessment date - Filter for entries with a value | |
assessmentDate.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
assessmentDate.not.exists |
query | boolean | No | Assessment date - Filter for entries without a value | |
assessmentDate.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
assessmentDate.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
assessmentDate.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
assessmentDate.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
clinicalRelevance |
query | None | No | Clinical relevance - Filter for single value choice | |
clinicalRelevance.anyOf |
query | array | No | Clinical relevance - ('Filter for excluding a subset of value choices',) | |
clinicalRelevance.exists |
query | boolean | No | Clinical relevance - Filter for entries with a value | |
clinicalRelevance.not |
query | None | No | Clinical relevance - ('Filter for all but a single value choice',) | |
clinicalRelevance.not.exists |
query | boolean | No | Clinical relevance - Filter for entries without a value | |
clinvar |
query | string | No | ClinVar accession number - Filter for full text matches | |
clinvar.anyOf |
query | array | No | ClinVar accession number - Filter for entries where at least one reference matches the query | |
clinvar.beginsWith |
query | string | No | ClinVar accession number - Filter for entries starting with the text | |
clinvar.contains |
query | string | No | ClinVar accession number - Filter for partial text matches | |
clinvar.endsWith |
query | string | No | ClinVar accession number - Filter for entries ending with the text | |
clinvar.exists |
query | boolean | No | ClinVar accession number - Filter for entries with a value | |
clinvar.not |
query | string | No | ClinVar accession number - Filter for full text mismatches | |
clinvar.not.anyOf |
query | array | No | ClinVar accession number - Filter for entries where at least one reference mismatches the query | |
clinvar.not.beginsWith |
query | string | No | ClinVar accession number - Filter for entries not starting with the text | |
clinvar.not.contains |
query | string | No | ClinVar accession number - Filter for partial text mismatches | |
clinvar.not.endsWith |
query | string | No | ClinVar accession number - Filter for entries not ending with the text | |
clinvar.not.exists |
query | boolean | No | ClinVar accession number - Filter for entries without a value | |
confidence |
query | None | No | Confidence - Filter for single value choice | |
confidence.anyOf |
query | array | No | Confidence - ('Filter for excluding a subset of value choices',) | |
confidence.exists |
query | boolean | No | Confidence - Filter for entries with a value | |
confidence.not |
query | None | No | Confidence - ('Filter for all but a single value choice',) | |
confidence.not.exists |
query | boolean | No | Confidence - Filter for entries without a value | |
coordinateSystem |
query | string | No | Coordinate system - Filter for a matching concept code | |
coordinateSystem.anyOf |
query | array | No | Coordinate system - Filter for a matching set of concept codes | |
coordinateSystem.descendantsOf |
query | string | No | Coordinate system - Filter for all child concepts of a given concepts code | |
coordinateSystem.exists |
query | boolean | No | Coordinate system - Filter for entries with a value | |
coordinateSystem.not |
query | string | No | Coordinate system - Filter for a mismatching concept code | |
coordinateSystem.not.anyOf |
query | array | No | Coordinate system - Filter for a mismmatching set of concept codes | |
coordinateSystem.not.exists |
query | boolean | No | Coordinate system - Filter for entries without a value | |
copyNumber.between |
query | array | No | Copy number - Filter for entries with values between two specified values (inclusive) | |
copyNumber.equal |
query | integer | No | Copy number - Filter for entries with values exactly equal to the specified value | |
copyNumber.exists |
query | boolean | No | Copy number - Filter for entries with a value | |
copyNumber.greaterThan |
query | integer | No | Copy number - Filter for entries with values greater than the specified value | |
copyNumber.greaterThanOrEqual |
query | integer | No | Copy number - Filter for entries with values greater than or equal to the specified value | |
copyNumber.lessThan |
query | integer | No | Copy number - Filter for entries with values less than the specified value | |
copyNumber.lessThanOrEqual |
query | integer | No | Copy number - Filter for entries with values less than or equal to the specified value | |
copyNumber.not.between |
query | array | No | Copy number - Filter for entries with values between two specified values (inclusive) | |
copyNumber.not.equal |
query | integer | No | Copy number - Filter for entries with values not equal to the specified value | |
copyNumber.not.exists |
query | boolean | No | Copy number - Filter for entries without a value | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Date - Filter for entries with dates on or before the specified value | |
dnaChangePosition.between |
query | array | No | DNA change position - Filter for entries with values between two specified values (inclusive) | |
dnaChangePosition.equal |
query | integer | No | DNA change position - Filter for entries with values exactly equal to the specified value | |
dnaChangePosition.exists |
query | boolean | No | DNA change position - Filter for entries with a value | |
dnaChangePosition.greaterThan |
query | integer | No | DNA change position - Filter for entries with values greater than the specified value | |
dnaChangePosition.greaterThanOrEqual |
query | integer | No | DNA change position - Filter for entries with values greater than or equal to the specified value | |
dnaChangePosition.lessThan |
query | integer | No | DNA change position - Filter for entries with values less than the specified value | |
dnaChangePosition.lessThanOrEqual |
query | integer | No | DNA change position - Filter for entries with values less than or equal to the specified value | |
dnaChangePosition.not.between |
query | array | No | DNA change position - Filter for entries with values between two specified values (inclusive) | |
dnaChangePosition.not.equal |
query | integer | No | DNA change position - Filter for entries with values not equal to the specified value | |
dnaChangePosition.not.exists |
query | boolean | No | DNA change position - Filter for entries without a value | |
dnaChangePositionRange.containedBy |
query | array | No | DNA change range - Filter for entries whose Range are contined by the range | |
dnaChangePositionRange.contains |
query | array | No | DNA change range - Filter for entries containing the range | |
dnaChangePositionRange.exists |
query | boolean | No | DNA change range - Filter for entries with a value | |
dnaChangePositionRange.not.containedBy |
query | array | No | DNA change range - Filter for entries whose Range are not contined by the range | |
dnaChangePositionRange.not.contains |
query | array | No | DNA change range - Filter for entries not containing the range | |
dnaChangePositionRange.not.exists |
query | boolean | No | DNA change range - Filter for entries without a value | |
dnaChangePositionRange.not.overlaps |
query | array | No | DNA change range - Filter for entries not overlapping with the range | |
dnaChangePositionRange.overlaps |
query | array | No | DNA change range - Filter for entries overlapping with the range | |
dnaChangeType |
query | None | No | DNA change type - Filter for single value choice | |
dnaChangeType.anyOf |
query | array | No | DNA change type - ('Filter for excluding a subset of value choices',) | |
dnaChangeType.exists |
query | boolean | No | DNA change type - Filter for entries with a value | |
dnaChangeType.not |
query | None | No | DNA change type - ('Filter for all but a single value choice',) | |
dnaChangeType.not.exists |
query | boolean | No | DNA change type - Filter for entries without a value | |
dnaHgvs |
query | string | No | DNA HGVS - Filter for full text matches | |
dnaHgvs.anyOf |
query | array | No | DNA HGVS - Filter for entries where at least one reference matches the query | |
dnaHgvs.beginsWith |
query | string | No | DNA HGVS - Filter for entries starting with the text | |
dnaHgvs.contains |
query | string | No | DNA HGVS - Filter for partial text matches | |
dnaHgvs.endsWith |
query | string | No | DNA HGVS - Filter for entries ending with the text | |
dnaHgvs.exists |
query | boolean | No | DNA HGVS - Filter for entries with a value | |
dnaHgvs.not |
query | string | No | DNA HGVS - Filter for full text mismatches | |
dnaHgvs.not.anyOf |
query | array | No | DNA HGVS - Filter for entries where at least one reference mismatches the query | |
dnaHgvs.not.beginsWith |
query | string | No | DNA HGVS - Filter for entries not starting with the text | |
dnaHgvs.not.contains |
query | string | No | DNA HGVS - Filter for partial text mismatches | |
dnaHgvs.not.endsWith |
query | string | No | DNA HGVS - Filter for entries not ending with the text | |
dnaHgvs.not.exists |
query | boolean | No | DNA HGVS - Filter for entries without a value | |
dnaReferenceSequence |
query | string | No | DNA HGVS RefSeq - Filter for full text matches | |
dnaReferenceSequence.anyOf |
query | array | No | DNA HGVS RefSeq - Filter for entries where at least one reference matches the query | |
dnaReferenceSequence.beginsWith |
query | string | No | DNA HGVS RefSeq - Filter for entries starting with the text | |
dnaReferenceSequence.contains |
query | string | No | DNA HGVS RefSeq - Filter for partial text matches | |
dnaReferenceSequence.endsWith |
query | string | No | DNA HGVS RefSeq - Filter for entries ending with the text | |
dnaReferenceSequence.exists |
query | boolean | No | DNA HGVS RefSeq - Filter for entries with a value | |
dnaReferenceSequence.not |
query | string | No | DNA HGVS RefSeq - Filter for full text mismatches | |
dnaReferenceSequence.not.anyOf |
query | array | No | DNA HGVS RefSeq - Filter for entries where at least one reference mismatches the query | |
dnaReferenceSequence.not.beginsWith |
query | string | No | DNA HGVS RefSeq - Filter for entries not starting with the text | |
dnaReferenceSequence.not.contains |
query | string | No | DNA HGVS RefSeq - Filter for partial text mismatches | |
dnaReferenceSequence.not.endsWith |
query | string | No | DNA HGVS RefSeq - Filter for entries not ending with the text | |
dnaReferenceSequence.not.exists |
query | boolean | No | DNA HGVS RefSeq - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
genePanel |
query | string | No | Gene panel - Filter for full text matches | |
genePanel.anyOf |
query | array | No | Gene panel - Filter for entries where at least one reference matches the query | |
genePanel.beginsWith |
query | string | No | Gene panel - Filter for entries starting with the text | |
genePanel.contains |
query | string | No | Gene panel - Filter for partial text matches | |
genePanel.endsWith |
query | string | No | Gene panel - Filter for entries ending with the text | |
genePanel.exists |
query | boolean | No | Gene panel - Filter for entries with a value | |
genePanel.not |
query | string | No | Gene panel - Filter for full text mismatches | |
genePanel.not.anyOf |
query | array | No | Gene panel - Filter for entries where at least one reference mismatches the query | |
genePanel.not.beginsWith |
query | string | No | Gene panel - Filter for entries not starting with the text | |
genePanel.not.contains |
query | string | No | Gene panel - Filter for partial text mismatches | |
genePanel.not.endsWith |
query | string | No | Gene panel - Filter for entries not ending with the text | |
genePanel.not.exists |
query | boolean | No | Gene panel - Filter for entries without a value | |
genes |
query | string | No | Gene(s) - Filter for a matching concept code | |
genes.allOf |
query | array | No | Gene(s) - Filter for entries matching all of the concepts | |
genes.anyOf |
query | array | No | Gene(s) - Filter for a matching set of concept codes | |
genes.descendantsOf |
query | string | No | Gene(s) - Filter for all child concepts of a given concepts code | |
genes.not |
query | string | No | Gene(s) - Filter for a mismatching concept code | |
genes.not.allOf |
query | array | No | Gene(s) - Filter for entries mismatching all of the concepts | |
genes.not.anyOf |
query | array | No | Gene(s) - Filter for a mismmatching set of concept codes | |
genomeAssemblyVersion |
query | string | No | Genome assembly version - Filter for a matching concept code | |
genomeAssemblyVersion.anyOf |
query | array | No | Genome assembly version - Filter for a matching set of concept codes | |
genomeAssemblyVersion.descendantsOf |
query | string | No | Genome assembly version - Filter for all child concepts of a given concepts code | |
genomeAssemblyVersion.exists |
query | boolean | No | Genome assembly version - Filter for entries with a value | |
genomeAssemblyVersion.not |
query | string | No | Genome assembly version - Filter for a mismatching concept code | |
genomeAssemblyVersion.not.anyOf |
query | array | No | Genome assembly version - Filter for a mismmatching set of concept codes | |
genomeAssemblyVersion.not.exists |
query | boolean | No | Genome assembly version - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
inheritance |
query | string | No | Inheritance - Filter for a matching concept code | |
inheritance.anyOf |
query | array | No | Inheritance - Filter for a matching set of concept codes | |
inheritance.descendantsOf |
query | string | No | Inheritance - Filter for all child concepts of a given concepts code | |
inheritance.exists |
query | boolean | No | Inheritance - Filter for entries with a value | |
inheritance.not |
query | string | No | Inheritance - Filter for a mismatching concept code | |
inheritance.not.anyOf |
query | array | No | Inheritance - Filter for a mismmatching set of concept codes | |
inheritance.not.exists |
query | boolean | No | Inheritance - Filter for entries without a value | |
isPathogenic |
query | boolean | No | Is Pathogenic - Filter for yes/no statement | |
isPathogenic.exists |
query | boolean | No | Is Pathogenic - Filter for entries with a value | |
isPathogenic.not.exists |
query | boolean | No | Is Pathogenic - Filter for entries without a value | |
isVUS |
query | boolean | No | Is VUS - Filter for yes/no statement | |
isVUS.exists |
query | boolean | No | Is VUS - Filter for entries with a value | |
isVUS.not.exists |
query | boolean | No | Is VUS - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
molecularConsequence |
query | string | No | Molecular consequence - Filter for a matching concept code | |
molecularConsequence.anyOf |
query | array | No | Molecular consequence - Filter for a matching set of concept codes | |
molecularConsequence.descendantsOf |
query | string | No | Molecular consequence - Filter for all child concepts of a given concepts code | |
molecularConsequence.exists |
query | boolean | No | Molecular consequence - Filter for entries with a value | |
molecularConsequence.not |
query | string | No | Molecular consequence - Filter for a mismatching concept code | |
molecularConsequence.not.anyOf |
query | array | No | Molecular consequence - Filter for a mismmatching set of concept codes | |
molecularConsequence.not.exists |
query | boolean | No | Molecular consequence - Filter for entries without a value | |
nucleotidesLength.between |
query | array | No | Variant length - Filter for entries with values between two specified values (inclusive) | |
nucleotidesLength.equal |
query | integer | No | Variant length - Filter for entries with values exactly equal to the specified value | |
nucleotidesLength.exists |
query | boolean | No | Variant length - Filter for entries with a value | |
nucleotidesLength.greaterThan |
query | integer | No | Variant length - Filter for entries with values greater than the specified value | |
nucleotidesLength.greaterThanOrEqual |
query | integer | No | Variant length - Filter for entries with values greater than or equal to the specified value | |
nucleotidesLength.lessThan |
query | integer | No | Variant length - Filter for entries with values less than the specified value | |
nucleotidesLength.lessThanOrEqual |
query | integer | No | Variant length - Filter for entries with values less than or equal to the specified value | |
nucleotidesLength.not.between |
query | array | No | Variant length - Filter for entries with values between two specified values (inclusive) | |
nucleotidesLength.not.equal |
query | integer | No | Variant length - Filter for entries with values not equal to the specified value | |
nucleotidesLength.not.exists |
query | boolean | No | Variant length - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
proteinChangeType |
query | None | No | Protein change type - Filter for single value choice | |
proteinChangeType.anyOf |
query | array | No | Protein change type - ('Filter for excluding a subset of value choices',) | |
proteinChangeType.exists |
query | boolean | No | Protein change type - Filter for entries with a value | |
proteinChangeType.not |
query | None | No | Protein change type - ('Filter for all but a single value choice',) | |
proteinChangeType.not.exists |
query | boolean | No | Protein change type - Filter for entries without a value | |
proteinHgvs |
query | string | No | Protein HGVS - Filter for full text matches | |
proteinHgvs.anyOf |
query | array | No | Protein HGVS - Filter for entries where at least one reference matches the query | |
proteinHgvs.beginsWith |
query | string | No | Protein HGVS - Filter for entries starting with the text | |
proteinHgvs.contains |
query | string | No | Protein HGVS - Filter for partial text matches | |
proteinHgvs.endsWith |
query | string | No | Protein HGVS - Filter for entries ending with the text | |
proteinHgvs.exists |
query | boolean | No | Protein HGVS - Filter for entries with a value | |
proteinHgvs.not |
query | string | No | Protein HGVS - Filter for full text mismatches | |
proteinHgvs.not.anyOf |
query | array | No | Protein HGVS - Filter for entries where at least one reference mismatches the query | |
proteinHgvs.not.beginsWith |
query | string | No | Protein HGVS - Filter for entries not starting with the text | |
proteinHgvs.not.contains |
query | string | No | Protein HGVS - Filter for partial text mismatches | |
proteinHgvs.not.endsWith |
query | string | No | Protein HGVS - Filter for entries not ending with the text | |
proteinHgvs.not.exists |
query | boolean | No | Protein HGVS - Filter for entries without a value | |
proteinReferenceSequence |
query | string | No | Protein HGVS RefSeq - Filter for full text matches | |
proteinReferenceSequence.anyOf |
query | array | No | Protein HGVS RefSeq - Filter for entries where at least one reference matches the query | |
proteinReferenceSequence.beginsWith |
query | string | No | Protein HGVS RefSeq - Filter for entries starting with the text | |
proteinReferenceSequence.contains |
query | string | No | Protein HGVS RefSeq - Filter for partial text matches | |
proteinReferenceSequence.endsWith |
query | string | No | Protein HGVS RefSeq - Filter for entries ending with the text | |
proteinReferenceSequence.exists |
query | boolean | No | Protein HGVS RefSeq - Filter for entries with a value | |
proteinReferenceSequence.not |
query | string | No | Protein HGVS RefSeq - Filter for full text mismatches | |
proteinReferenceSequence.not.anyOf |
query | array | No | Protein HGVS RefSeq - Filter for entries where at least one reference mismatches the query | |
proteinReferenceSequence.not.beginsWith |
query | string | No | Protein HGVS RefSeq - Filter for entries not starting with the text | |
proteinReferenceSequence.not.contains |
query | string | No | Protein HGVS RefSeq - Filter for partial text mismatches | |
proteinReferenceSequence.not.endsWith |
query | string | No | Protein HGVS RefSeq - Filter for entries not ending with the text | |
proteinReferenceSequence.not.exists |
query | boolean | No | Protein HGVS RefSeq - Filter for entries without a value | |
regions |
query | string | No | Gene regions - Filter for full text matches | |
regions.anyOf |
query | array | No | Gene regions - Filter for entries where at least one reference matches the query | |
regions.beginsWith |
query | string | No | Gene regions - Filter for entries starting with the text | |
regions.contains |
query | string | No | Gene regions - Filter for partial text matches | |
regions.endsWith |
query | string | No | Gene regions - Filter for entries ending with the text | |
regions.exists |
query | boolean | No | Gene regions - Filter for entries with a value | |
regions.not |
query | string | No | Gene regions - Filter for full text mismatches | |
regions.not.anyOf |
query | array | No | Gene regions - Filter for entries where at least one reference mismatches the query | |
regions.not.beginsWith |
query | string | No | Gene regions - Filter for entries not starting with the text | |
regions.not.contains |
query | string | No | Gene regions - Filter for partial text mismatches | |
regions.not.endsWith |
query | string | No | Gene regions - Filter for entries not ending with the text | |
regions.not.exists |
query | boolean | No | Gene regions - Filter for entries without a value | |
rnaChangePosition |
query | string | No | RNA change position - Filter for full text matches | |
rnaChangePosition.anyOf |
query | array | No | RNA change position - Filter for entries where at least one reference matches the query | |
rnaChangePosition.beginsWith |
query | string | No | RNA change position - Filter for entries starting with the text | |
rnaChangePosition.contains |
query | string | No | RNA change position - Filter for partial text matches | |
rnaChangePosition.endsWith |
query | string | No | RNA change position - Filter for entries ending with the text | |
rnaChangePosition.exists |
query | boolean | No | RNA change position - Filter for entries with a value | |
rnaChangePosition.not |
query | string | No | RNA change position - Filter for full text mismatches | |
rnaChangePosition.not.anyOf |
query | array | No | RNA change position - Filter for entries where at least one reference mismatches the query | |
rnaChangePosition.not.beginsWith |
query | string | No | RNA change position - Filter for entries not starting with the text | |
rnaChangePosition.not.contains |
query | string | No | RNA change position - Filter for partial text mismatches | |
rnaChangePosition.not.endsWith |
query | string | No | RNA change position - Filter for entries not ending with the text | |
rnaChangePosition.not.exists |
query | boolean | No | RNA change position - Filter for entries without a value | |
rnaChangeType |
query | None | No | RNA change type - Filter for single value choice | |
rnaChangeType.anyOf |
query | array | No | RNA change type - ('Filter for excluding a subset of value choices',) | |
rnaChangeType.exists |
query | boolean | No | RNA change type - Filter for entries with a value | |
rnaChangeType.not |
query | None | No | RNA change type - ('Filter for all but a single value choice',) | |
rnaChangeType.not.exists |
query | boolean | No | RNA change type - Filter for entries without a value | |
rnaHgvs |
query | string | No | RNA HGVS - Filter for full text matches | |
rnaHgvs.anyOf |
query | array | No | RNA HGVS - Filter for entries where at least one reference matches the query | |
rnaHgvs.beginsWith |
query | string | No | RNA HGVS - Filter for entries starting with the text | |
rnaHgvs.contains |
query | string | No | RNA HGVS - Filter for partial text matches | |
rnaHgvs.endsWith |
query | string | No | RNA HGVS - Filter for entries ending with the text | |
rnaHgvs.exists |
query | boolean | No | RNA HGVS - Filter for entries with a value | |
rnaHgvs.not |
query | string | No | RNA HGVS - Filter for full text mismatches | |
rnaHgvs.not.anyOf |
query | array | No | RNA HGVS - Filter for entries where at least one reference mismatches the query | |
rnaHgvs.not.beginsWith |
query | string | No | RNA HGVS - Filter for entries not starting with the text | |
rnaHgvs.not.contains |
query | string | No | RNA HGVS - Filter for partial text mismatches | |
rnaHgvs.not.endsWith |
query | string | No | RNA HGVS - Filter for entries not ending with the text | |
rnaHgvs.not.exists |
query | boolean | No | RNA HGVS - Filter for entries without a value | |
rnaReferenceSequence |
query | string | No | RNA HGVS RefSeq - Filter for full text matches | |
rnaReferenceSequence.anyOf |
query | array | No | RNA HGVS RefSeq - Filter for entries where at least one reference matches the query | |
rnaReferenceSequence.beginsWith |
query | string | No | RNA HGVS RefSeq - Filter for entries starting with the text | |
rnaReferenceSequence.contains |
query | string | No | RNA HGVS RefSeq - Filter for partial text matches | |
rnaReferenceSequence.endsWith |
query | string | No | RNA HGVS RefSeq - Filter for entries ending with the text | |
rnaReferenceSequence.exists |
query | boolean | No | RNA HGVS RefSeq - Filter for entries with a value | |
rnaReferenceSequence.not |
query | string | No | RNA HGVS RefSeq - Filter for full text mismatches | |
rnaReferenceSequence.not.anyOf |
query | array | No | RNA HGVS RefSeq - Filter for entries where at least one reference mismatches the query | |
rnaReferenceSequence.not.beginsWith |
query | string | No | RNA HGVS RefSeq - Filter for entries not starting with the text | |
rnaReferenceSequence.not.contains |
query | string | No | RNA HGVS RefSeq - Filter for partial text mismatches | |
rnaReferenceSequence.not.endsWith |
query | string | No | RNA HGVS RefSeq - Filter for entries not ending with the text | |
rnaReferenceSequence.not.exists |
query | boolean | No | RNA HGVS RefSeq - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
zygosity |
query | string | No | Zygosity - Filter for a matching concept code | |
zygosity.anyOf |
query | array | No | Zygosity - Filter for a matching set of concept codes | |
zygosity.descendantsOf |
query | string | No | Zygosity - Filter for all child concepts of a given concepts code | |
zygosity.exists |
query | boolean | No | Zygosity - Filter for entries with a value | |
zygosity.not |
query | string | No | Zygosity - Filter for a mismatching concept code | |
zygosity.not.anyOf |
query | array | No | Zygosity - Filter for a mismmatching set of concept codes | |
zygosity.not.exists |
query | boolean | No | Zygosity - Filter for entries without a value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"isPathogenic": true,
"isVUS": true,
"dnaHgvs": "string",
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaHgvs": "string",
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinHgvs": "string",
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
],
"id": "cf30e7d9-263c-4b74-9337-5686b4fdb20a",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fbc91675-8a97-4bb4-82bd-578a2169ec7d",
"date": "2022-04-13",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"genes": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/genomic-variants¶
Create Genomic Variant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e698a114-d726-48e5-af5e-65274da15ea1",
"date": "2022-04-13",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"genes": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
]
}
Schema of the request body
{
"properties": {
"dnaHgvs": {
"description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
"title": "DNA HGVS",
"type": "string"
},
"rnaHgvs": {
"description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
"title": "RNA HGVS",
"type": "string"
},
"proteinHgvs": {
"description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
"title": "Protein HGVS",
"type": "string"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who' genomic variant is described",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
"format": "date",
"title": "Date",
"type": "string",
"x-expanded": false
},
"assessmentDate": {
"description": "Date at which the genomic variant was assessed and/or reported.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"genePanel": {
"description": "Commercial or official name of the gene panel tested to identify the variant",
"maxLength": 200,
"title": "Gene panel",
"type": "string",
"x-expanded": false
},
"assessment": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantAssessmentChoices",
"maxLength": 15
}
],
"description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
"title": "Assessment",
"x-expanded": false
},
"confidence": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantConfidenceChoices",
"maxLength": 15
}
],
"description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
"title": "Confidence",
"x-expanded": false
},
"analysisMethod": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Analysis method used to detect the variant",
"title": "Analysis method",
"x-expanded": false,
"x-terminology": "StructuralVariantAnalysisMethod"
},
"clinicalRelevance": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
}
],
"description": "Classification of the clinical relevance or pathogenicity of the variant.",
"title": "Clinical relevance",
"x-expanded": false
},
"genomeAssemblyVersion": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The reference genome assembly versionused in this analysis.",
"title": "Genome assembly version",
"x-expanded": false,
"x-terminology": "ReferenceGenomeBuild"
},
"molecularConsequence": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
"title": "Molecular consequence",
"x-expanded": false,
"x-terminology": "MolecularConsequence"
},
"copyNumber": {
"description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
"title": "Copy number",
"type": "integer",
"x-expanded": false
},
"alleleFrequency": {
"description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
"title": "Allele frequency",
"type": "number",
"x-expanded": false
},
"alleleDepth": {
"description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
"title": "Allele depth (reads)",
"type": "integer",
"x-expanded": false
},
"zygosity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The observed level of occurrence of the variant in the set of chromosomes.",
"title": "Zygosity",
"x-expanded": false,
"x-terminology": "Zygosity"
},
"inheritance": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant inheritance origin (if known).",
"title": "Inheritance",
"x-expanded": false,
"x-terminology": "VariantInheritance"
},
"coordinateSystem": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
"title": "Coordinate system",
"x-expanded": false,
"x-terminology": "GenomicCoordinateSystem"
},
"clinvar": {
"description": "Accession number in the ClinVar variant database, given for cross-reference.",
"title": "ClinVar accession number",
"type": "string",
"x-expanded": false
},
"genes": {
"description": "Gene(s) affected by this variant",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Gene(s)",
"type": "array",
"x-expanded": false,
"x-terminology": "Gene"
}
},
"required": [
"caseId",
"date"
],
"title": "GenomicVariantCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/genomic-variants/{genomicVariantId}¶
Get Genomic Variant By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
genomicVariantId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"isPathogenic": true,
"isVUS": true,
"dnaHgvs": "string",
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaHgvs": "string",
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinHgvs": "string",
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
],
"id": "cc58db0e-b1a3-44ff-8a64-581002de2bef",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "446af88c-2783-4c7a-9cca-e5af22ad1364",
"date": "2022-04-13",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"genes": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"isPathogenic": {
"description": "Whether the genomic variant is considered pathogenic in a clinical setting",
"title": "Is Pathogenic",
"type": "boolean"
},
"isVUS": {
"description": "Whether the genomic variant is considered a variant of unknown signifiance (VUS)",
"title": "Is VUS",
"type": "boolean"
},
"dnaHgvs": {
"description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
"title": "DNA HGVS",
"type": "string"
},
"dnaReferenceSequence": {
"description": "DNA reference sequence identifier used as dna HGVS reference.",
"pattern": "(?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})|(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)",
"title": "DNA HGVS RefSeq",
"type": "string"
},
"dnaChangePosition": {
"description": "DNA-level single-nucleotide position where the variant was found.",
"title": "DNA change position",
"type": "integer"
},
"dnaChangePositionRange": {
"allOf": [
{
"$ref": "#/components/schemas/Range"
}
],
"description": "DNA-level single-nucleotide position where the variant was found.",
"title": "DNA change range"
},
"dnaChangeType": {
"allOf": [
{
"$ref": "#/components/schemas/DNAChangeType"
}
],
"description": "DNA variant type of variant.",
"title": "DNA change type"
},
"rnaHgvs": {
"description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
"title": "RNA HGVS",
"type": "string"
},
"rnaReferenceSequence": {
"description": "RNA reference sequence identifier used as rna HGVS reference.",
"pattern": "(?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})",
"title": "RNA HGVS RefSeq",
"type": "string"
},
"rnaChangePosition": {
"description": "RNA-level nucleotide position/range where the variant was found.",
"pattern": "(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))",
"title": "RNA change position",
"type": "string"
},
"rnaChangeType": {
"allOf": [
{
"$ref": "#/components/schemas/RNAChangeType"
}
],
"description": "RNA variant type of variant.",
"title": "RNA change type"
},
"proteinHgvs": {
"description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
"title": "Protein HGVS",
"type": "string"
},
"proteinReferenceSequence": {
"description": "Protein reference sequence identifier used as protein HGVS reference.",
"pattern": "(?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})",
"title": "Protein HGVS RefSeq",
"type": "string"
},
"proteinChangeType": {
"allOf": [
{
"$ref": "#/components/schemas/ProteinChangeType"
}
],
"description": "Protein variant type of variant.",
"title": "Protein change type"
},
"nucleotidesLength": {
"description": "Length of the variant in nucleotides",
"title": "Variant length",
"type": "integer"
},
"regions": {
"description": "Gene regions (exons, introns, UTRs) affected by the variant. Estimated from MANE reference sequences.",
"items": {
"type": "string"
},
"title": "Gene regions",
"type": "array"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who' genomic variant is described",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
"format": "date",
"title": "Date",
"type": "string",
"x-expanded": false
},
"assessmentDate": {
"description": "Date at which the genomic variant was assessed and/or reported.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"genePanel": {
"description": "Commercial or official name of the gene panel tested to identify the variant",
"maxLength": 200,
"title": "Gene panel",
"type": "string",
"x-expanded": false
},
"assessment": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantAssessmentChoices",
"maxLength": 15
}
],
"description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
"title": "Assessment",
"x-expanded": false
},
"confidence": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantConfidenceChoices",
"maxLength": 15
}
],
"description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
"title": "Confidence",
"x-expanded": false
},
"analysisMethod": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Analysis method used to detect the variant",
"title": "Analysis method",
"x-expanded": false,
"x-terminology": "StructuralVariantAnalysisMethod"
},
"clinicalRelevance": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
}
],
"description": "Classification of the clinical relevance or pathogenicity of the variant.",
"title": "Clinical relevance",
"x-expanded": false
},
"genomeAssemblyVersion": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The reference genome assembly versionused in this analysis.",
"title": "Genome assembly version",
"x-expanded": false,
"x-terminology": "ReferenceGenomeBuild"
},
"molecularConsequence": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
"title": "Molecular consequence",
"x-expanded": false,
"x-terminology": "MolecularConsequence"
},
"copyNumber": {
"description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
"title": "Copy number",
"type": "integer",
"x-expanded": false
},
"alleleFrequency": {
"description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
"title": "Allele frequency",
"type": "number",
"x-expanded": false
},
"alleleDepth": {
"description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
"title": "Allele depth (reads)",
"type": "integer",
"x-expanded": false
},
"zygosity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The observed level of occurrence of the variant in the set of chromosomes.",
"title": "Zygosity",
"x-expanded": false,
"x-terminology": "Zygosity"
},
"inheritance": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant inheritance origin (if known).",
"title": "Inheritance",
"x-expanded": false,
"x-terminology": "VariantInheritance"
},
"coordinateSystem": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
"title": "Coordinate system",
"x-expanded": false,
"x-terminology": "GenomicCoordinateSystem"
},
"clinvar": {
"description": "Accession number in the ClinVar variant database, given for cross-reference.",
"title": "ClinVar accession number",
"type": "string",
"x-expanded": false
},
"genes": {
"description": "Gene(s) affected by this variant",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Gene(s)",
"type": "array",
"x-expanded": false,
"x-terminology": "Gene"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"description"
],
"title": "GenomicVariant",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/genomic-variants/{genomicVariantId}¶
Update Genomic Variant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicVariantId |
path | string | No |
Request body
{
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e7c490f8-4ea4-4a57-a6d2-035170f51d0e",
"date": "2022-04-13",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"genes": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
]
}
Schema of the request body
{
"properties": {
"dnaHgvs": {
"description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
"title": "DNA HGVS",
"type": "string"
},
"rnaHgvs": {
"description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
"title": "RNA HGVS",
"type": "string"
},
"proteinHgvs": {
"description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
"title": "Protein HGVS",
"type": "string"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who' genomic variant is described",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
"format": "date",
"title": "Date",
"type": "string",
"x-expanded": false
},
"assessmentDate": {
"description": "Date at which the genomic variant was assessed and/or reported.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"genePanel": {
"description": "Commercial or official name of the gene panel tested to identify the variant",
"maxLength": 200,
"title": "Gene panel",
"type": "string",
"x-expanded": false
},
"assessment": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantAssessmentChoices",
"maxLength": 15
}
],
"description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
"title": "Assessment",
"x-expanded": false
},
"confidence": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantConfidenceChoices",
"maxLength": 15
}
],
"description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
"title": "Confidence",
"x-expanded": false
},
"analysisMethod": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Analysis method used to detect the variant",
"title": "Analysis method",
"x-expanded": false,
"x-terminology": "StructuralVariantAnalysisMethod"
},
"clinicalRelevance": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
}
],
"description": "Classification of the clinical relevance or pathogenicity of the variant.",
"title": "Clinical relevance",
"x-expanded": false
},
"genomeAssemblyVersion": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The reference genome assembly versionused in this analysis.",
"title": "Genome assembly version",
"x-expanded": false,
"x-terminology": "ReferenceGenomeBuild"
},
"molecularConsequence": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
"title": "Molecular consequence",
"x-expanded": false,
"x-terminology": "MolecularConsequence"
},
"copyNumber": {
"description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
"title": "Copy number",
"type": "integer",
"x-expanded": false
},
"alleleFrequency": {
"description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
"title": "Allele frequency",
"type": "number",
"x-expanded": false
},
"alleleDepth": {
"description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
"title": "Allele depth (reads)",
"type": "integer",
"x-expanded": false
},
"zygosity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The observed level of occurrence of the variant in the set of chromosomes.",
"title": "Zygosity",
"x-expanded": false,
"x-terminology": "Zygosity"
},
"inheritance": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant inheritance origin (if known).",
"title": "Inheritance",
"x-expanded": false,
"x-terminology": "VariantInheritance"
},
"coordinateSystem": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
"title": "Coordinate system",
"x-expanded": false,
"x-terminology": "GenomicCoordinateSystem"
},
"clinvar": {
"description": "Accession number in the ClinVar variant database, given for cross-reference.",
"title": "ClinVar accession number",
"type": "string",
"x-expanded": false
},
"genes": {
"description": "Gene(s) affected by this variant",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Gene(s)",
"type": "array",
"x-expanded": false,
"x-terminology": "Gene"
}
},
"required": [
"caseId",
"date"
],
"title": "GenomicVariantCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/genomic-variants/{genomicVariantId}¶
Delete Genomic Variant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicVariantId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/genomic-variants/{genomicVariantId}/history/events¶
Get All Genomic Variant History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicVariantId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/genomic-variants/{genomicVariantId}/history/events/{eventId}¶
Get Genomic Variant History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
genomicVariantId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/genomic-variants/{genomicVariantId}/history/events/{eventId}/reversion¶
Revert Genomic Variant To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
genomicVariantId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/autocomplete/gene-panels¶
Gell All Genomic Panels
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
query |
query | string | No |
Response 200 OK
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Genomic Signatures¶
GET /api/v1/genomic-signatures¶
Get All Genomic Signatures Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
category |
query | None | No | Category - Filter for single value choice | |
category.anyOf |
query | array | No | Category - ('Filter for excluding a subset of value choices',) | |
category.not |
query | None | No | Category - ('Filter for all but a single value choice',) | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/genomic-signatures¶
Create Genomic Signature
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TumorMutationalBurdenCreate"
},
{
"$ref": "#/components/schemas/MicrosatelliteInstabilityCreate"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosityCreate"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiencyCreate"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurdenCreate"
},
{
"$ref": "#/components/schemas/AneuploidScoreCreate"
}
],
"title": "Payload"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/genomic-signatures/{genomicSignatureId}¶
Get Genomic Signature By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
genomicSignatureId |
path | string | No |
Response 200 OK
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/MicrosatelliteInstability"
},
{
"$ref": "#/components/schemas/TumorMutationalBurden"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosity"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiency"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurden"
},
{
"$ref": "#/components/schemas/AneuploidScore"
}
]
}
Response 404 Not Found
PUT /api/v1/genomic-signatures/{genomicSignatureId}¶
Update Genomic Signature
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicSignatureId |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TumorMutationalBurdenCreate"
},
{
"$ref": "#/components/schemas/MicrosatelliteInstabilityCreate"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosityCreate"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiencyCreate"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurdenCreate"
},
{
"$ref": "#/components/schemas/AneuploidScoreCreate"
}
],
"title": "Payload"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/genomic-signatures/{genomicSignatureId}¶
Delete Genomic Signature
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicSignatureId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/genomic-signatures/{genomicSignatureId}/history/events¶
Get All Genomic Signature History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicSignatureId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/genomic-signatures/{genomicSignatureId}/history/events/{eventId}¶
Get Genomic Signature History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
genomicSignatureId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "Represents an audit/history event capturing changes in the system.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEvent",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/genomic-signatures/{genomicSignatureId}/history/events/{eventId}/reversion¶
Revert Genomic Signature To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
genomicSignatureId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Lifestyles¶
GET /api/v1/lifestyles¶
Get All Lifestyles Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
alcoholConsumption |
query | string | No | Alcohol consumption - Filter for a matching concept code | |
alcoholConsumption.anyOf |
query | array | No | Alcohol consumption - Filter for a matching set of concept codes | |
alcoholConsumption.descendantsOf |
query | string | No | Alcohol consumption - Filter for all child concepts of a given concepts code | |
alcoholConsumption.exists |
query | boolean | No | Alcohol consumption - Filter for entries with a value | |
alcoholConsumption.not |
query | string | No | Alcohol consumption - Filter for a mismatching concept code | |
alcoholConsumption.not.anyOf |
query | array | No | Alcohol consumption - Filter for a mismmatching set of concept codes | |
alcoholConsumption.not.exists |
query | boolean | No | Alcohol consumption - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
exposures |
query | string | No | Exposures - Filter for a matching concept code | |
exposures.allOf |
query | array | No | Exposures - Filter for entries matching all of the concepts | |
exposures.anyOf |
query | array | No | Exposures - Filter for a matching set of concept codes | |
exposures.descendantsOf |
query | string | No | Exposures - Filter for all child concepts of a given concepts code | |
exposures.exists |
query | boolean | No | Exposures - Filter for entries with a value | |
exposures.not |
query | string | No | Exposures - Filter for a mismatching concept code | |
exposures.not.allOf |
query | array | No | Exposures - Filter for entries mismatching all of the concepts | |
exposures.not.anyOf |
query | array | No | Exposures - Filter for a mismmatching set of concept codes | |
exposures.not.exists |
query | boolean | No | Exposures - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
nightSleep.between |
query | array | No | Night sleep - Filter for entries with values between two specified values (inclusive) | |
nightSleep.equal |
query | number | No | Night sleep - Filter for entries with values exactly equal to the specified value | |
nightSleep.exists |
query | boolean | No | Night sleep - Filter for entries with a value | |
nightSleep.greaterThan |
query | number | No | Night sleep - Filter for entries with values greater than the specified value | |
nightSleep.greaterThanOrEqual |
query | number | No | Night sleep - Filter for entries with values greater than or equal to the specified value | |
nightSleep.lessThan |
query | number | No | Night sleep - Filter for entries with values less than the specified value | |
nightSleep.lessThanOrEqual |
query | number | No | Night sleep - Filter for entries with values less than or equal to the specified value | |
nightSleep.not.between |
query | array | No | Night sleep - Filter for entries with values between two specified values (inclusive) | |
nightSleep.not.equal |
query | number | No | Night sleep - Filter for entries with values not equal to the specified value | |
nightSleep.not.exists |
query | boolean | No | Night sleep - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
recreationalDrugs |
query | string | No | Recreational drugs - Filter for a matching concept code | |
recreationalDrugs.allOf |
query | array | No | Recreational drugs - Filter for entries matching all of the concepts | |
recreationalDrugs.anyOf |
query | array | No | Recreational drugs - Filter for a matching set of concept codes | |
recreationalDrugs.descendantsOf |
query | string | No | Recreational drugs - Filter for all child concepts of a given concepts code | |
recreationalDrugs.exists |
query | boolean | No | Recreational drugs - Filter for entries with a value | |
recreationalDrugs.not |
query | string | No | Recreational drugs - Filter for a mismatching concept code | |
recreationalDrugs.not.allOf |
query | array | No | Recreational drugs - Filter for entries mismatching all of the concepts | |
recreationalDrugs.not.anyOf |
query | array | No | Recreational drugs - Filter for a mismmatching set of concept codes | |
recreationalDrugs.not.exists |
query | boolean | No | Recreational drugs - Filter for entries without a value | |
smokingPackyears.between |
query | array | No | Smoking packyears - Filter for entries with values between two specified values (inclusive) | |
smokingPackyears.equal |
query | number | No | Smoking packyears - Filter for entries with values exactly equal to the specified value | |
smokingPackyears.exists |
query | boolean | No | Smoking packyears - Filter for entries with a value | |
smokingPackyears.greaterThan |
query | number | No | Smoking packyears - Filter for entries with values greater than the specified value | |
smokingPackyears.greaterThanOrEqual |
query | number | No | Smoking packyears - Filter for entries with values greater than or equal to the specified value | |
smokingPackyears.lessThan |
query | number | No | Smoking packyears - Filter for entries with values less than the specified value | |
smokingPackyears.lessThanOrEqual |
query | number | No | Smoking packyears - Filter for entries with values less than or equal to the specified value | |
smokingPackyears.not.between |
query | array | No | Smoking packyears - Filter for entries with values between two specified values (inclusive) | |
smokingPackyears.not.equal |
query | number | No | Smoking packyears - Filter for entries with values not equal to the specified value | |
smokingPackyears.not.exists |
query | boolean | No | Smoking packyears - Filter for entries without a value | |
smokingQuited.between |
query | array | No | Time since quitted smoking - Filter for entries with values between two specified values (inclusive) | |
smokingQuited.equal |
query | number | No | Time since quitted smoking - Filter for entries with values exactly equal to the specified value | |
smokingQuited.exists |
query | boolean | No | Time since quitted smoking - Filter for entries with a value | |
smokingQuited.greaterThan |
query | number | No | Time since quitted smoking - Filter for entries with values greater than the specified value | |
smokingQuited.greaterThanOrEqual |
query | number | No | Time since quitted smoking - Filter for entries with values greater than or equal to the specified value | |
smokingQuited.lessThan |
query | number | No | Time since quitted smoking - Filter for entries with values less than the specified value | |
smokingQuited.lessThanOrEqual |
query | number | No | Time since quitted smoking - Filter for entries with values less than or equal to the specified value | |
smokingQuited.not.between |
query | array | No | Time since quitted smoking - Filter for entries with values between two specified values (inclusive) | |
smokingQuited.not.equal |
query | number | No | Time since quitted smoking - Filter for entries with values not equal to the specified value | |
smokingQuited.not.exists |
query | boolean | No | Time since quitted smoking - Filter for entries without a value | |
smokingStatus |
query | string | No | Smoking Status - Filter for a matching concept code | |
smokingStatus.anyOf |
query | array | No | Smoking Status - Filter for a matching set of concept codes | |
smokingStatus.descendantsOf |
query | string | No | Smoking Status - Filter for all child concepts of a given concepts code | |
smokingStatus.exists |
query | boolean | No | Smoking Status - Filter for entries with a value | |
smokingStatus.not |
query | string | No | Smoking Status - Filter for a mismatching concept code | |
smokingStatus.not.anyOf |
query | array | No | Smoking Status - Filter for a mismmatching set of concept codes | |
smokingStatus.not.exists |
query | boolean | No | Smoking Status - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "25e173e4-2415-45da-8f60-265cdc46ec8f",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6de27196-a1ca-4d43-8901-19238386d9f6",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"exposures": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/lifestyles¶
Create Lifestyle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "45e2c610-c22d-4233-91ad-3cd995412cf8",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"exposures": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's lifestyle is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"smokingStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Tobacco consumption status",
"title": "Smoking Status",
"x-expanded": false,
"x-terminology": "SmokingStatus"
},
"smokingPackyears": {
"description": "Smoking pack-years (if applicable)",
"title": "Smoking packyears",
"type": "number",
"x-expanded": false
},
"smokingQuited": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated time since quitting smoking (if applicable)",
"title": "Time since quitted smoking",
"x-default-unit": "year",
"x-expanded": false,
"x-measure": "Time"
},
"alcoholConsumption": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Frequency of alcohol consumption",
"title": "Alcohol consumption",
"x-expanded": false,
"x-terminology": "AlcoholConsumptionFrequency"
},
"nightSleep": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated average sleep time per night",
"title": "Night sleep",
"x-default-unit": "hour",
"x-expanded": false,
"x-measure": "Time"
},
"recreationalDrugs": {
"description": "Any recreational drug(s) used by the patient",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Recreational drugs",
"type": "array",
"x-expanded": false,
"x-terminology": "RecreationalDrug"
},
"exposures": {
"description": "Environmental or occupational exposures to hazards or carcinogenic agents",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Exposures",
"type": "array",
"x-expanded": false,
"x-terminology": "ExposureAgent"
}
},
"required": [
"caseId",
"date"
],
"title": "LifestyleCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/lifestyles/{lifestyleId}¶
Get Lifestyle By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
lifestyleId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"id": "b5b67346-3791-4f38-9b0a-f38d359c4ba8",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6bbe015b-5c94-45f3-8895-f8ed1e244ebb",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"exposures": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's lifestyle is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"smokingStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Tobacco consumption status",
"title": "Smoking Status",
"x-expanded": false,
"x-terminology": "SmokingStatus"
},
"smokingPackyears": {
"description": "Smoking pack-years (if applicable)",
"title": "Smoking packyears",
"type": "number",
"x-expanded": false
},
"smokingQuited": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated time since quitting smoking (if applicable)",
"title": "Time since quitted smoking",
"x-default-unit": "year",
"x-expanded": false,
"x-measure": "Time"
},
"alcoholConsumption": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Frequency of alcohol consumption",
"title": "Alcohol consumption",
"x-expanded": false,
"x-terminology": "AlcoholConsumptionFrequency"
},
"nightSleep": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated average sleep time per night",
"title": "Night sleep",
"x-default-unit": "hour",
"x-expanded": false,
"x-measure": "Time"
},
"recreationalDrugs": {
"description": "Any recreational drug(s) used by the patient",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Recreational drugs",
"type": "array",
"x-expanded": false,
"x-terminology": "RecreationalDrug"
},
"exposures": {
"description": "Environmental or occupational exposures to hazards or carcinogenic agents",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Exposures",
"type": "array",
"x-expanded": false,
"x-terminology": "ExposureAgent"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"description"
],
"title": "Lifestyle",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/lifestyles/{lifestyleId}¶
Update Lifestyle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
lifestyleId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d3e879c4-e535-4691-a6ec-f66305fbe4a2",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"exposures": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's lifestyle is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"smokingStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Tobacco consumption status",
"title": "Smoking Status",
"x-expanded": false,
"x-terminology": "SmokingStatus"
},
"smokingPackyears": {
"description": "Smoking pack-years (if applicable)",
"title": "Smoking packyears",
"type": "number",
"x-expanded": false
},
"smokingQuited": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated time since quitting smoking (if applicable)",
"title": "Time since quitted smoking",
"x-default-unit": "year",
"x-expanded": false,
"x-measure": "Time"
},
"alcoholConsumption": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Frequency of alcohol consumption",
"title": "Alcohol consumption",
"x-expanded": false,
"x-terminology": "AlcoholConsumptionFrequency"
},
"nightSleep": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated average sleep time per night",
"title": "Night sleep",
"x-default-unit": "hour",
"x-expanded": false,
"x-measure": "Time"
},
"recreationalDrugs": {
"description": "Any recreational drug(s) used by the patient",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Recreational drugs",
"type": "array",
"x-expanded": false,
"x-terminology": "RecreationalDrug"
},
"exposures": {
"description": "Environmental or occupational exposures to hazards or carcinogenic agents",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Exposures",
"type": "array",
"x-expanded": false,
"x-terminology": "ExposureAgent"
}
},
"required": [
"caseId",
"date"
],
"title": "LifestyleCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/lifestyles/{lifestyleId}¶
Delete Lifestyle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
lifestyleId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/lifestyles/{lifestyleId}/history/events¶
Get All Lifestyle History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
lifestyleId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/lifestyles/{lifestyleId}/history/events/{eventId}¶
Get Lifestyle History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
lifestyleId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/lifestyles/{lifestyleId}/history/events/{eventId}/reversion¶
Revert Lifestyle To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
lifestyleId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Family Histories¶
GET /api/v1/family-histories¶
Get All Family Member Histories Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
contributedToDeath |
query | boolean | No | Contributed to death - Filter for yes/no statement | |
contributedToDeath.exists |
query | boolean | No | Contributed to death - Filter for entries with a value | |
contributedToDeath.not.exists |
query | boolean | No | Contributed to death - Filter for entries without a value | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
hadCancer |
query | boolean | No | Had cancer - Filter for yes/no statement | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
morphology |
query | string | No | Morphology - Filter for a matching concept code | |
morphology.anyOf |
query | array | No | Morphology - Filter for a matching set of concept codes | |
morphology.descendantsOf |
query | string | No | Morphology - Filter for all child concepts of a given concepts code | |
morphology.exists |
query | boolean | No | Morphology - Filter for entries with a value | |
morphology.not |
query | string | No | Morphology - Filter for a mismatching concept code | |
morphology.not.anyOf |
query | array | No | Morphology - Filter for a mismmatching set of concept codes | |
morphology.not.exists |
query | boolean | No | Morphology - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
onsetAge.between |
query | array | No | Onset age - Filter for entries with values between two specified values (inclusive) | |
onsetAge.equal |
query | integer | No | Onset age - Filter for entries with values exactly equal to the specified value | |
onsetAge.exists |
query | boolean | No | Onset age - Filter for entries with a value | |
onsetAge.greaterThan |
query | integer | No | Onset age - Filter for entries with values greater than the specified value | |
onsetAge.greaterThanOrEqual |
query | integer | No | Onset age - Filter for entries with values greater than or equal to the specified value | |
onsetAge.lessThan |
query | integer | No | Onset age - Filter for entries with values less than the specified value | |
onsetAge.lessThanOrEqual |
query | integer | No | Onset age - Filter for entries with values less than or equal to the specified value | |
onsetAge.not.between |
query | array | No | Onset age - Filter for entries with values between two specified values (inclusive) | |
onsetAge.not.equal |
query | integer | No | Onset age - Filter for entries with values not equal to the specified value | |
onsetAge.not.exists |
query | boolean | No | Onset age - Filter for entries without a value | |
ordering |
query | None | No | ||
relationship |
query | string | No | Relationship - Filter for a matching concept code | |
relationship.anyOf |
query | array | No | Relationship - Filter for a matching set of concept codes | |
relationship.descendantsOf |
query | string | No | Relationship - Filter for all child concepts of a given concepts code | |
relationship.not |
query | string | No | Relationship - Filter for a mismatching concept code | |
relationship.not.anyOf |
query | array | No | Relationship - Filter for a mismmatching set of concept codes | |
topography |
query | string | No | Topography - Filter for a matching concept code | |
topography.anyOf |
query | array | No | Topography - Filter for a matching set of concept codes | |
topography.descendantsOf |
query | string | No | Topography - Filter for all child concepts of a given concepts code | |
topography.exists |
query | boolean | No | Topography - Filter for entries with a value | |
topography.not |
query | string | No | Topography - Filter for a mismatching concept code | |
topography.not.anyOf |
query | array | No | Topography - Filter for a mismmatching set of concept codes | |
topography.not.exists |
query | boolean | No | Topography - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "0fcb402b-b049-470c-979f-e3cedc046ea4",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "35c4b852-d137-459d-8754-0a51ee3cd06f",
"date": "2022-04-13",
"relationship": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"hadCancer": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/family-histories¶
Create Family History
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ca2b15c9-cb88-471c-9002-94639a077e42",
"date": "2022-04-13",
"relationship": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"hadCancer": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's family's history is being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"relationship": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Relationship to the patient",
"title": "Relationship",
"x-expanded": false,
"x-terminology": "FamilyMemberType"
},
"hadCancer": {
"description": "Whether the family member has a history of cancer",
"title": "Had cancer",
"type": "boolean",
"x-expanded": false
},
"contributedToDeath": {
"description": "Whether the cancer contributed to the cause of death of the family member",
"title": "Contributed to death",
"type": "boolean",
"x-expanded": false
},
"onsetAge": {
"description": "Age at which the family member's cancer manifested",
"title": "Onset age",
"type": "integer",
"x-expanded": false
},
"topography": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Estimated or actual topography of the family member's cancer",
"title": "Topography",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"morphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the family member's cancer (if known)",
"title": "Morphology",
"x-expanded": false,
"x-terminology": "CancerMorphology"
}
},
"required": [
"caseId",
"date",
"relationship",
"hadCancer"
],
"title": "FamilyHistoryCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/family-histories/{familyHistoryId}¶
Get Family History By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
familyHistoryId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"id": "e5ce2323-c93d-469c-bd1d-749e79a8223e",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "af964ae5-6f21-4249-84a2-77dc6ad5887f",
"date": "2022-04-13",
"relationship": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"hadCancer": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's family's history is being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"relationship": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Relationship to the patient",
"title": "Relationship",
"x-expanded": false,
"x-terminology": "FamilyMemberType"
},
"hadCancer": {
"description": "Whether the family member has a history of cancer",
"title": "Had cancer",
"type": "boolean",
"x-expanded": false
},
"contributedToDeath": {
"description": "Whether the cancer contributed to the cause of death of the family member",
"title": "Contributed to death",
"type": "boolean",
"x-expanded": false
},
"onsetAge": {
"description": "Age at which the family member's cancer manifested",
"title": "Onset age",
"type": "integer",
"x-expanded": false
},
"topography": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Estimated or actual topography of the family member's cancer",
"title": "Topography",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"morphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the family member's cancer (if known)",
"title": "Morphology",
"x-expanded": false,
"x-terminology": "CancerMorphology"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"relationship",
"hadCancer",
"description"
],
"title": "FamilyHistory",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/family-histories/{familyHistoryId}¶
Delete Family History
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
familyHistoryId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/family-histories/{familyHistoryId}¶
Update Family History
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
familyHistoryId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6e8e11c2-1201-44ec-be4a-e7b7e0529941",
"date": "2022-04-13",
"relationship": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"hadCancer": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's family's history is being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"relationship": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Relationship to the patient",
"title": "Relationship",
"x-expanded": false,
"x-terminology": "FamilyMemberType"
},
"hadCancer": {
"description": "Whether the family member has a history of cancer",
"title": "Had cancer",
"type": "boolean",
"x-expanded": false
},
"contributedToDeath": {
"description": "Whether the cancer contributed to the cause of death of the family member",
"title": "Contributed to death",
"type": "boolean",
"x-expanded": false
},
"onsetAge": {
"description": "Age at which the family member's cancer manifested",
"title": "Onset age",
"type": "integer",
"x-expanded": false
},
"topography": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Estimated or actual topography of the family member's cancer",
"title": "Topography",
"x-expanded": false,
"x-terminology": "CancerTopography"
},
"morphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the family member's cancer (if known)",
"title": "Morphology",
"x-expanded": false,
"x-terminology": "CancerMorphology"
}
},
"required": [
"caseId",
"date",
"relationship",
"hadCancer"
],
"title": "FamilyHistoryCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/family-histories/{familyHistoryId}/history/events¶
Get All Family History History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
familyHistoryId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/family-histories/{familyHistoryId}/history/events/{eventId}¶
Get Family History History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
familyHistoryId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/family-histories/{familyHistoryId}/history/events/{eventId}/reversion¶
Revert Family History To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
familyHistoryId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Comorbidities Assessments¶
GET /api/v1/comorbidities-assessments¶
Get All Comorbidities Assessments Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
absentConditions |
query | string | No | Absent comorbid conditions - Filter for a matching concept code | |
absentConditions.allOf |
query | array | No | Absent comorbid conditions - Filter for entries matching all of the concepts | |
absentConditions.anyOf |
query | array | No | Absent comorbid conditions - Filter for a matching set of concept codes | |
absentConditions.descendantsOf |
query | string | No | Absent comorbid conditions - Filter for all child concepts of a given concepts code | |
absentConditions.exists |
query | boolean | No | Absent comorbid conditions - Filter for entries with a value | |
absentConditions.not |
query | string | No | Absent comorbid conditions - Filter for a mismatching concept code | |
absentConditions.not.allOf |
query | array | No | Absent comorbid conditions - Filter for entries mismatching all of the concepts | |
absentConditions.not.anyOf |
query | array | No | Absent comorbid conditions - Filter for a mismmatching set of concept codes | |
absentConditions.not.exists |
query | boolean | No | Absent comorbid conditions - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
indexConditionId |
query | string | No | Index neoplastic entity - Filter for reference matches | |
indexConditionId.anyOf |
query | array | No | Index neoplastic entity - Filter for entries where at least one reference matches the query | |
indexConditionId.beginsWith |
query | string | No | Index neoplastic entity - Filter for entries starting with the text | |
indexConditionId.contains |
query | string | No | Index neoplastic entity - Filter for partial text matches | |
indexConditionId.endsWith |
query | string | No | Index neoplastic entity - Filter for entries ending with the text | |
indexConditionId.not |
query | string | No | Index neoplastic entity - Filter for reference mismatches | |
indexConditionId.not.anyOf |
query | array | No | Index neoplastic entity - Filter for entries where at least one reference mismatches the query | |
indexConditionId.not.beginsWith |
query | string | No | Index neoplastic entity - Filter for entries not starting with the text | |
indexConditionId.not.contains |
query | string | No | Index neoplastic entity - Filter for partial text mismatches | |
indexConditionId.not.endsWith |
query | string | No | Index neoplastic entity - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
panel |
query | None | No | Panel - Filter for single value choice | |
panel.anyOf |
query | array | No | Panel - ('Filter for excluding a subset of value choices',) | |
panel.exists |
query | boolean | No | Panel - Filter for entries with a value | |
panel.not |
query | None | No | Panel - ('Filter for all but a single value choice',) | |
panel.not.exists |
query | boolean | No | Panel - Filter for entries without a value | |
presentConditions |
query | string | No | Present comorbid conditions - Filter for a matching concept code | |
presentConditions.allOf |
query | array | No | Present comorbid conditions - Filter for entries matching all of the concepts | |
presentConditions.anyOf |
query | array | No | Present comorbid conditions - Filter for a matching set of concept codes | |
presentConditions.descendantsOf |
query | string | No | Present comorbid conditions - Filter for all child concepts of a given concepts code | |
presentConditions.exists |
query | boolean | No | Present comorbid conditions - Filter for entries with a value | |
presentConditions.not |
query | string | No | Present comorbid conditions - Filter for a mismatching concept code | |
presentConditions.not.allOf |
query | array | No | Present comorbid conditions - Filter for entries mismatching all of the concepts | |
presentConditions.not.anyOf |
query | array | No | Present comorbid conditions - Filter for a mismmatching set of concept codes | |
presentConditions.not.exists |
query | boolean | No | Present comorbid conditions - Filter for entries without a value | |
score.between |
query | array | No | Score - Filter for entries with values between two specified values (inclusive) | |
score.equal |
query | integer | No | Score - Filter for entries with values exactly equal to the specified value | |
score.exists |
query | boolean | No | Score - Filter for entries with a value | |
score.greaterThan |
query | integer | No | Score - Filter for entries with values greater than the specified value | |
score.greaterThanOrEqual |
query | integer | No | Score - Filter for entries with values greater than or equal to the specified value | |
score.lessThan |
query | integer | No | Score - Filter for entries with values less than the specified value | |
score.lessThanOrEqual |
query | integer | No | Score - Filter for entries with values less than or equal to the specified value | |
score.not.between |
query | array | No | Score - Filter for entries with values between two specified values (inclusive) | |
score.not.equal |
query | integer | No | Score - Filter for entries with values not equal to the specified value | |
score.not.exists |
query | boolean | No | Score - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"score": null,
"id": "34255b78-25c1-4490-ad03-87a33cc44de8",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d6d8acdd-2466-4e41-8e69-56c3ab6388ce",
"date": "2022-04-13",
"indexConditionId": "383bd9b0-d9d2-4072-8502-98f2ce1df431",
"panel": null,
"presentConditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"absentConditions": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Schema of the response body
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/comorbidities-assessments¶
Create Comorbidities Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "57d6bc87-7800-427b-b919-3747c8742dc6",
"date": "2022-04-13",
"indexConditionId": "68e41d5b-e5c7-4607-896f-40a179a0357d",
"panel": null,
"presentConditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"absentConditions": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's comorbidities are being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"indexConditionId": {
"description": "The primary neoplastic entity against which comorbidities are assessed",
"format": "uuid",
"title": "Index neoplastic entity",
"type": "string",
"x-expanded": false
},
"panel": {
"allOf": [
{
"$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices",
"maxLength": 30
}
],
"description": "Comorbidities panel",
"title": "Panel",
"x-expanded": false
},
"presentConditions": {
"description": "Present comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Present comorbid conditions",
"type": "array",
"x-expanded": false,
"x-terminology": "ICD10Condition"
},
"absentConditions": {
"description": "Absent comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Absent comorbid conditions",
"type": "array",
"x-expanded": false,
"x-terminology": "ICD10Condition"
}
},
"required": [
"caseId",
"date",
"indexConditionId"
],
"title": "ComorbiditiesAssessmentCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}¶
Get Comorbidities Assessment By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
comorbiditiesAssessmentId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"score": null,
"id": "58391a0c-68ca-46a8-9af8-3a5f04785187",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6f56d3f9-2a03-4df9-b1aa-1b046565eb84",
"date": "2022-04-13",
"indexConditionId": "ecc15cc4-65d2-4f33-8e10-c8876d643aad",
"panel": null,
"presentConditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"absentConditions": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"score": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Comorbidity score",
"title": "Score"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's comorbidities are being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"indexConditionId": {
"description": "The primary neoplastic entity against which comorbidities are assessed",
"format": "uuid",
"title": "Index neoplastic entity",
"type": "string",
"x-expanded": false
},
"panel": {
"allOf": [
{
"$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices",
"maxLength": 30
}
],
"description": "Comorbidities panel",
"title": "Panel",
"x-expanded": false
},
"presentConditions": {
"description": "Present comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Present comorbid conditions",
"type": "array",
"x-expanded": false,
"x-terminology": "ICD10Condition"
},
"absentConditions": {
"description": "Absent comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Absent comorbid conditions",
"type": "array",
"x-expanded": false,
"x-terminology": "ICD10Condition"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"indexConditionId",
"description"
],
"title": "ComorbiditiesAssessment",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}¶
Delete Comorbidities Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}¶
Update Comorbidities Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fc7ec568-f8ca-44ee-857d-638fc4c1ddf6",
"date": "2022-04-13",
"indexConditionId": "030bc19a-d077-45b4-b88b-5bba5bbd0194",
"panel": null,
"presentConditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"absentConditions": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's comorbidities are being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"indexConditionId": {
"description": "The primary neoplastic entity against which comorbidities are assessed",
"format": "uuid",
"title": "Index neoplastic entity",
"type": "string",
"x-expanded": false
},
"panel": {
"allOf": [
{
"$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices",
"maxLength": 30
}
],
"description": "Comorbidities panel",
"title": "Panel",
"x-expanded": false
},
"presentConditions": {
"description": "Present comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Present comorbid conditions",
"type": "array",
"x-expanded": false,
"x-terminology": "ICD10Condition"
},
"absentConditions": {
"description": "Absent comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Absent comorbid conditions",
"type": "array",
"x-expanded": false,
"x-terminology": "ICD10Condition"
}
},
"required": [
"caseId",
"date",
"indexConditionId"
],
"title": "ComorbiditiesAssessmentCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events¶
Get All Comorbidities Assessment History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events/{eventId}¶
Get Comorbidities Assessment History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No | ||
eventId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events/{eventId}/reversion¶
Revert Comorbidities Assessment To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No | ||
eventId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/comorbidities-assessments/meta/panels¶
Get All Comorbidities Panels
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"name": "string",
"categories": [
{
"label": "string",
"default": null,
"conditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
]
}
]
}
]
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/comorbidities-assessments/meta/panels/{panel}¶
Get Comorbidities Panel By Name
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
panel |
path | string | No |
Response 200 OK
{
"name": "string",
"categories": [
{
"label": "string",
"default": null,
"conditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
]
}
]
}
Schema of the response body
{
"properties": {
"name": {
"description": "Comorbidity panel name",
"title": "Name",
"type": "string"
},
"categories": {
"description": "Comorbidity panel categories",
"items": {
"$ref": "#/components/schemas/ComorbidityPanelCategory"
},
"title": "Categories",
"type": "array"
}
},
"required": [
"name",
"categories"
],
"title": "ComorbiditiesPanel",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Vitals¶
GET /api/v1/vitals¶
Get All Vitals Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
bloodPressureDiastolic.between |
query | array | No | Diastolic blood pressure - Filter for entries with values between two specified values (inclusive) | |
bloodPressureDiastolic.equal |
query | number | No | Diastolic blood pressure - Filter for entries with values exactly equal to the specified value | |
bloodPressureDiastolic.exists |
query | boolean | No | Diastolic blood pressure - Filter for entries with a value | |
bloodPressureDiastolic.greaterThan |
query | number | No | Diastolic blood pressure - Filter for entries with values greater than the specified value | |
bloodPressureDiastolic.greaterThanOrEqual |
query | number | No | Diastolic blood pressure - Filter for entries with values greater than or equal to the specified value | |
bloodPressureDiastolic.lessThan |
query | number | No | Diastolic blood pressure - Filter for entries with values less than the specified value | |
bloodPressureDiastolic.lessThanOrEqual |
query | number | No | Diastolic blood pressure - Filter for entries with values less than or equal to the specified value | |
bloodPressureDiastolic.not.between |
query | array | No | Diastolic blood pressure - Filter for entries with values between two specified values (inclusive) | |
bloodPressureDiastolic.not.equal |
query | number | No | Diastolic blood pressure - Filter for entries with values not equal to the specified value | |
bloodPressureDiastolic.not.exists |
query | boolean | No | Diastolic blood pressure - Filter for entries without a value | |
bloodPressureSystolic.between |
query | array | No | Systolic blood pressure - Filter for entries with values between two specified values (inclusive) | |
bloodPressureSystolic.equal |
query | number | No | Systolic blood pressure - Filter for entries with values exactly equal to the specified value | |
bloodPressureSystolic.exists |
query | boolean | No | Systolic blood pressure - Filter for entries with a value | |
bloodPressureSystolic.greaterThan |
query | number | No | Systolic blood pressure - Filter for entries with values greater than the specified value | |
bloodPressureSystolic.greaterThanOrEqual |
query | number | No | Systolic blood pressure - Filter for entries with values greater than or equal to the specified value | |
bloodPressureSystolic.lessThan |
query | number | No | Systolic blood pressure - Filter for entries with values less than the specified value | |
bloodPressureSystolic.lessThanOrEqual |
query | number | No | Systolic blood pressure - Filter for entries with values less than or equal to the specified value | |
bloodPressureSystolic.not.between |
query | array | No | Systolic blood pressure - Filter for entries with values between two specified values (inclusive) | |
bloodPressureSystolic.not.equal |
query | number | No | Systolic blood pressure - Filter for entries with values not equal to the specified value | |
bloodPressureSystolic.not.exists |
query | boolean | No | Systolic blood pressure - Filter for entries without a value | |
bodyMassIndex.between |
query | array | No | Body mass index - Filter for entries with values between two specified values (inclusive) | |
bodyMassIndex.equal |
query | number | No | Body mass index - Filter for entries with values exactly equal to the specified value | |
bodyMassIndex.exists |
query | boolean | No | Body mass index - Filter for entries with a value | |
bodyMassIndex.greaterThan |
query | number | No | Body mass index - Filter for entries with values greater than the specified value | |
bodyMassIndex.greaterThanOrEqual |
query | number | No | Body mass index - Filter for entries with values greater than or equal to the specified value | |
bodyMassIndex.lessThan |
query | number | No | Body mass index - Filter for entries with values less than the specified value | |
bodyMassIndex.lessThanOrEqual |
query | number | No | Body mass index - Filter for entries with values less than or equal to the specified value | |
bodyMassIndex.not.between |
query | array | No | Body mass index - Filter for entries with values between two specified values (inclusive) | |
bodyMassIndex.not.equal |
query | number | No | Body mass index - Filter for entries with values not equal to the specified value | |
bodyMassIndex.not.exists |
query | boolean | No | Body mass index - Filter for entries without a value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
height.between |
query | array | No | Height - Filter for entries with values between two specified values (inclusive) | |
height.equal |
query | number | No | Height - Filter for entries with values exactly equal to the specified value | |
height.exists |
query | boolean | No | Height - Filter for entries with a value | |
height.greaterThan |
query | number | No | Height - Filter for entries with values greater than the specified value | |
height.greaterThanOrEqual |
query | number | No | Height - Filter for entries with values greater than or equal to the specified value | |
height.lessThan |
query | number | No | Height - Filter for entries with values less than the specified value | |
height.lessThanOrEqual |
query | number | No | Height - Filter for entries with values less than or equal to the specified value | |
height.not.between |
query | array | No | Height - Filter for entries with values between two specified values (inclusive) | |
height.not.equal |
query | number | No | Height - Filter for entries with values not equal to the specified value | |
height.not.exists |
query | boolean | No | Height - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
temperature.between |
query | array | No | Temperature - Filter for entries with values between two specified values (inclusive) | |
temperature.equal |
query | number | No | Temperature - Filter for entries with values exactly equal to the specified value | |
temperature.exists |
query | boolean | No | Temperature - Filter for entries with a value | |
temperature.greaterThan |
query | number | No | Temperature - Filter for entries with values greater than the specified value | |
temperature.greaterThanOrEqual |
query | number | No | Temperature - Filter for entries with values greater than or equal to the specified value | |
temperature.lessThan |
query | number | No | Temperature - Filter for entries with values less than the specified value | |
temperature.lessThanOrEqual |
query | number | No | Temperature - Filter for entries with values less than or equal to the specified value | |
temperature.not.between |
query | array | No | Temperature - Filter for entries with values between two specified values (inclusive) | |
temperature.not.equal |
query | number | No | Temperature - Filter for entries with values not equal to the specified value | |
temperature.not.exists |
query | boolean | No | Temperature - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
weight.between |
query | array | No | Weight - Filter for entries with values between two specified values (inclusive) | |
weight.equal |
query | number | No | Weight - Filter for entries with values exactly equal to the specified value | |
weight.exists |
query | boolean | No | Weight - Filter for entries with a value | |
weight.greaterThan |
query | number | No | Weight - Filter for entries with values greater than the specified value | |
weight.greaterThanOrEqual |
query | number | No | Weight - Filter for entries with values greater than or equal to the specified value | |
weight.lessThan |
query | number | No | Weight - Filter for entries with values less than the specified value | |
weight.lessThanOrEqual |
query | number | No | Weight - Filter for entries with values less than or equal to the specified value | |
weight.not.between |
query | array | No | Weight - Filter for entries with values between two specified values (inclusive) | |
weight.not.equal |
query | number | No | Weight - Filter for entries with values not equal to the specified value | |
weight.not.exists |
query | boolean | No | Weight - Filter for entries without a value |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"bodyMassIndex": null,
"id": "8cd21755-ecba-4b2d-ba08-8716284c44ab",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "db474a56-32cd-45ed-8ccf-f22452ff4ec1",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/vitals¶
Create Vitals
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a8f4aed3-5891-4cce-a30a-f3fd18e78c91",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's vitals are assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the vitals were recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"height": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Height of the patient",
"title": "Height",
"x-default-unit": "m",
"x-expanded": false,
"x-measure": "Distance"
},
"weight": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Weight of the patient",
"title": "Weight",
"x-default-unit": "kg",
"x-expanded": false,
"x-measure": "Mass"
},
"bloodPressureSystolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Systolic blood pressure of the patient",
"title": "Systolic blood pressure",
"x-default-unit": "mmHg",
"x-expanded": false,
"x-measure": "Pressure"
},
"bloodPressureDiastolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Diastolic blood pressure of the patient",
"title": "Diastolic blood pressure",
"x-default-unit": "mmHg",
"x-expanded": false,
"x-measure": "Pressure"
},
"temperature": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Temperature of the patient",
"title": "Temperature",
"x-default-unit": "celsius",
"x-expanded": false,
"x-measure": "Temperature"
}
},
"required": [
"caseId",
"date"
],
"title": "VitalsCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/vitals/{vitalsId}¶
Get Vitals By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
vitalsId |
path | string | No |
Response 200 OK
{
"anonymized": true,
"bodyMassIndex": null,
"id": "e726ac21-89b4-4de3-b691-54af79e7c923",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6d618b7c-fbd6-458a-a677-11ab0b180641",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"bodyMassIndex": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Bodymass index of the patient",
"title": "Body mass index",
"x-measure": "MassPerArea"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's vitals are assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the vitals were recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"height": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Height of the patient",
"title": "Height",
"x-default-unit": "m",
"x-expanded": false,
"x-measure": "Distance"
},
"weight": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Weight of the patient",
"title": "Weight",
"x-default-unit": "kg",
"x-expanded": false,
"x-measure": "Mass"
},
"bloodPressureSystolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Systolic blood pressure of the patient",
"title": "Systolic blood pressure",
"x-default-unit": "mmHg",
"x-expanded": false,
"x-measure": "Pressure"
},
"bloodPressureDiastolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Diastolic blood pressure of the patient",
"title": "Diastolic blood pressure",
"x-default-unit": "mmHg",
"x-expanded": false,
"x-measure": "Pressure"
},
"temperature": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Temperature of the patient",
"title": "Temperature",
"x-default-unit": "celsius",
"x-expanded": false,
"x-measure": "Temperature"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"caseId",
"date",
"description"
],
"title": "Vitals",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/vitals/{vitalsId}¶
Update Vitals
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
vitalsId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a1bc727c-b637-40a3-aa45-a6cbc6381b89",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"caseId": {
"description": "Indicates the case of the patient who's vitals are assesed",
"format": "uuid",
"title": "Patient case",
"type": "string",
"x-expanded": false
},
"date": {
"description": "Clinically-relevant date at which the vitals were recorded.",
"format": "date",
"title": "Assessment date",
"type": "string",
"x-expanded": false
},
"height": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Height of the patient",
"title": "Height",
"x-default-unit": "m",
"x-expanded": false,
"x-measure": "Distance"
},
"weight": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Weight of the patient",
"title": "Weight",
"x-default-unit": "kg",
"x-expanded": false,
"x-measure": "Mass"
},
"bloodPressureSystolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Systolic blood pressure of the patient",
"title": "Systolic blood pressure",
"x-default-unit": "mmHg",
"x-expanded": false,
"x-measure": "Pressure"
},
"bloodPressureDiastolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Diastolic blood pressure of the patient",
"title": "Diastolic blood pressure",
"x-default-unit": "mmHg",
"x-expanded": false,
"x-measure": "Pressure"
},
"temperature": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Temperature of the patient",
"title": "Temperature",
"x-default-unit": "celsius",
"x-expanded": false,
"x-measure": "Temperature"
}
},
"required": [
"caseId",
"date"
],
"title": "VitalsCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/vitals/{vitalsId}¶
Delete Vitals
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
vitalsId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/vitals/{vitalsId}/history/events¶
Get All Vitals History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
vitalsId |
path | string | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/vitals/{vitalsId}/history/events/{eventId}¶
Get Vitals History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
vitalsId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/vitals/{vitalsId}/history/events/{eventId}/reversion¶
Revert Vitals To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
vitalsId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Measures¶
GET /api/v1/measures/{measureName}/units¶
Get Measure Units
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
measureName |
path | string | No |
Response 200 OK
Response 404 Not Found
GET /api/v1/measures/{measureName}/units/default¶
Get Measure Default Units
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
measureName |
path | string | No |
Response 200 OK
Response 404 Not Found
POST /api/v1/measures/{measureName}/units/conversion¶
Convert Units
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
measureName |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"description": "Represents a measure value and its intended conversion to a new unit.\n\nAttributes:\n value (float): The numerical value of the measure.\n unit (str): The unit of the measure.\n newUnit (str): The new unit to convert the measure to.",
"properties": {
"value": {
"description": "The numerical value of the measure to be converted.",
"title": "Value",
"type": "number"
},
"unit": {
"description": "The current unit of the measure.",
"title": "Original Unit",
"type": "string"
},
"newUnit": {
"description": "The target unit to convert the measure into.",
"title": "New Unit",
"type": "string"
}
},
"required": [
"value",
"unit",
"newUnit"
],
"title": "MeasureConversion",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a measurable quantity with its value and unit.\n\nAttributes:\n value (float): The numerical value of the measure.\n unit (str): The unit in which the value is expressed.",
"properties": {
"value": {
"description": "The numerical value of the measure.",
"title": "Value",
"type": "number"
},
"unit": {
"description": "The unit of measurement (e.g., 'kg', 'm', 'ml').",
"title": "Unit",
"type": "string"
}
},
"required": [
"value",
"unit"
],
"title": "Measure",
"type": "object"
}
Response 404 Not Found
Terminology¶
GET /api/v1/terminologies/{terminologyName}/concepts¶
Get Terminology Concepts
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
codes |
query | None | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
query |
query | None | No | ||
terminologyName |
path | string | No |
Response 200 OK
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Cohorts¶
GET /api/v1/cohorts¶
Get All Cohorts Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
casesIds |
query | string | No | Cases - Filter for full text matches | |
casesIds.anyOf |
query | array | No | Cases - Filter for entries where at least one reference matches the query | |
casesIds.beginsWith |
query | string | No | Cases - Filter for entries starting with the text | |
casesIds.contains |
query | string | No | Cases - Filter for partial text matches | |
casesIds.endsWith |
query | string | No | Cases - Filter for entries ending with the text | |
casesIds.not |
query | string | No | Cases - Filter for full text mismatches | |
casesIds.not.anyOf |
query | array | No | Cases - Filter for entries where at least one reference mismatches the query | |
casesIds.not.beginsWith |
query | string | No | Cases - Filter for entries not starting with the text | |
casesIds.not.contains |
query | string | No | Cases - Filter for partial text mismatches | |
casesIds.not.endsWith |
query | string | No | Cases - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
createdBy |
query | string | No | Filter for a particular cohort creator by its username | |
excludeCriteria.exists |
query | boolean | No | Exclusion criteria - Filter for entries with a value | |
excludeCriteria.not.exists |
query | boolean | No | Exclusion criteria - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
frozenSetIds |
query | string | No | Frozen cases - Filter for full text matches | |
frozenSetIds.anyOf |
query | array | No | Frozen cases - Filter for entries where at least one reference matches the query | |
frozenSetIds.beginsWith |
query | string | No | Frozen cases - Filter for entries starting with the text | |
frozenSetIds.contains |
query | string | No | Frozen cases - Filter for partial text matches | |
frozenSetIds.endsWith |
query | string | No | Frozen cases - Filter for entries ending with the text | |
frozenSetIds.not |
query | string | No | Frozen cases - Filter for full text mismatches | |
frozenSetIds.not.anyOf |
query | array | No | Frozen cases - Filter for entries where at least one reference mismatches the query | |
frozenSetIds.not.beginsWith |
query | string | No | Frozen cases - Filter for entries not starting with the text | |
frozenSetIds.not.contains |
query | string | No | Frozen cases - Filter for partial text mismatches | |
frozenSetIds.not.endsWith |
query | string | No | Frozen cases - Filter for entries not ending with the text | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
includeCriteria.exists |
query | boolean | No | Inclusion criteria - Filter for entries with a value | |
includeCriteria.not.exists |
query | boolean | No | Inclusion criteria - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
manualChoicesIds |
query | string | No | Manually added cases - Filter for full text matches | |
manualChoicesIds.anyOf |
query | array | No | Manually added cases - Filter for entries where at least one reference matches the query | |
manualChoicesIds.beginsWith |
query | string | No | Manually added cases - Filter for entries starting with the text | |
manualChoicesIds.contains |
query | string | No | Manually added cases - Filter for partial text matches | |
manualChoicesIds.endsWith |
query | string | No | Manually added cases - Filter for entries ending with the text | |
manualChoicesIds.not |
query | string | No | Manually added cases - Filter for full text mismatches | |
manualChoicesIds.not.anyOf |
query | array | No | Manually added cases - Filter for entries where at least one reference mismatches the query | |
manualChoicesIds.not.beginsWith |
query | string | No | Manually added cases - Filter for entries not starting with the text | |
manualChoicesIds.not.contains |
query | string | No | Manually added cases - Filter for partial text mismatches | |
manualChoicesIds.not.endsWith |
query | string | No | Manually added cases - Filter for entries not ending with the text | |
name |
query | string | No | Cohort name - Filter for full text matches | |
name.anyOf |
query | array | No | Cohort name - Filter for entries where at least one reference matches the query | |
name.beginsWith |
query | string | No | Cohort name - Filter for entries starting with the text | |
name.contains |
query | string | No | Cohort name - Filter for partial text matches | |
name.endsWith |
query | string | No | Cohort name - Filter for entries ending with the text | |
name.not |
query | string | No | Cohort name - Filter for full text mismatches | |
name.not.anyOf |
query | array | No | Cohort name - Filter for entries where at least one reference mismatches the query | |
name.not.beginsWith |
query | string | No | Cohort name - Filter for entries not starting with the text | |
name.not.contains |
query | string | No | Cohort name - Filter for partial text mismatches | |
name.not.endsWith |
query | string | No | Cohort name - Filter for entries not ending with the text | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
population.between |
query | array | No | Population - Filter for entries with values between two specified values (inclusive) | |
population.equal |
query | integer | No | Population - Filter for entries with values exactly equal to the specified value | |
population.greaterThan |
query | integer | No | Population - Filter for entries with values greater than the specified value | |
population.greaterThanOrEqual |
query | integer | No | Population - Filter for entries with values greater than or equal to the specified value | |
population.lessThan |
query | integer | No | Population - Filter for entries with values less than the specified value | |
population.lessThanOrEqual |
query | integer | No | Population - Filter for entries with values less than or equal to the specified value | |
population.not.between |
query | array | No | Population - Filter for entries with values between two specified values (inclusive) | |
population.not.equal |
query | integer | No | Population - Filter for entries with values not equal to the specified value | |
projectId |
query | string | No | Project - Filter for reference matches | |
projectId.anyOf |
query | array | No | Project - Filter for entries where at least one reference matches the query | |
projectId.beginsWith |
query | string | No | Project - Filter for entries starting with the text | |
projectId.contains |
query | string | No | Project - Filter for partial text matches | |
projectId.endsWith |
query | string | No | Project - Filter for entries ending with the text | |
projectId.exists |
query | boolean | No | Project - Filter for entries with a value | |
projectId.not |
query | string | No | Project - Filter for reference mismatches | |
projectId.not.anyOf |
query | array | No | Project - Filter for entries where at least one reference mismatches the query | |
projectId.not.beginsWith |
query | string | No | Project - Filter for entries not starting with the text | |
projectId.not.contains |
query | string | No | Project - Filter for partial text mismatches | |
projectId.not.endsWith |
query | string | No | Project - Filter for entries not ending with the text | |
projectId.not.exists |
query | boolean | No | Project - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"population": 0,
"id": "33510efb-e2ef-4c16-8ed0-125f6160cd00",
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"includeCriteria": {},
"excludeCriteria": {},
"projectId": "ba976a28-a171-416f-ba71-a4ce01cf612f",
"casesIds": [
"5efeaf9b-439e-4993-bf51-92c3a8880283"
],
"manualChoicesIds": [
"5f073c16-7cb7-4483-8f28-1f0238ffa803"
],
"frozenSetIds": [
"5e8c5a71-f9d5-48a6-b6fd-401a3012e6e7"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/cohorts¶
Create Cohort
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"includeCriteria": null,
"excludeCriteria": null,
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"projectId": "6e7d4b06-3724-4574-8cf6-5cf3e4d0c8a1",
"casesIds": [
"f1de14df-18dd-49ba-be5a-4eacf6379968"
],
"manualChoicesIds": [
"cf442b34-23d2-4fe9-9493-01d6a683c7db"
],
"frozenSetIds": [
"6452bfdf-430d-4f53-afd4-50612145e677"
]
}
Schema of the request body
{
"description": "Schema for creating a new cohort, including cohort logic definitions.",
"properties": {
"includeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be included in the cohort",
"title": "Inclusion critera"
},
"excludeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be excluded from the cohort",
"title": "Exclusion critera"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"name": {
"description": "Name of the cohort",
"maxLength": 255,
"title": "Cohort name",
"type": "string",
"x-expanded": false
},
"projectId": {
"description": "Project to which the cohort is associated",
"format": "uuid",
"title": "Project",
"type": "string",
"x-expanded": false
},
"casesIds": {
"description": "Cases composing the cohort",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Cases",
"type": "array",
"x-expanded": false
},
"manualChoicesIds": {
"description": "Manually added cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Manually added cases",
"type": "array",
"x-expanded": false
},
"frozenSetIds": {
"description": "Frozen cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Frozen cases",
"type": "array",
"x-expanded": false
}
},
"required": [
"name"
],
"title": "CohortCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}¶
Get Cohort By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Response 200 OK
{
"population": 0,
"id": "97d96ad3-e8d2-422a-86c5-f20b196f3480",
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"includeCriteria": {},
"excludeCriteria": {},
"projectId": "e72e6b48-f682-42cd-b17d-3e028cff1241",
"casesIds": [
"520dc621-4978-4467-872a-10a64d93fdbf"
],
"manualChoicesIds": [
"fda89f52-4f97-4ac7-bf84-ba3566ecc2a3"
],
"frozenSetIds": [
"fafbc63a-d6fa-432f-93d6-5b3940f915af"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"description": "Schema for retrieving a cohort record.",
"properties": {
"population": {
"description": "Cohort population",
"title": "Population",
"type": "integer"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"name": {
"description": "Name of the cohort",
"maxLength": 255,
"title": "Cohort name",
"type": "string",
"x-expanded": false
},
"includeCriteria": {
"description": "JSON object defining inclusion criteria",
"title": "Inclusion criteria",
"type": "object",
"x-expanded": false
},
"excludeCriteria": {
"description": "JSON object defining exclusion criteria",
"title": "Exclusion criteria",
"type": "object",
"x-expanded": false
},
"projectId": {
"description": "Project to which the cohort is associated",
"format": "uuid",
"title": "Project",
"type": "string",
"x-expanded": false
},
"casesIds": {
"description": "Cases composing the cohort",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Cases",
"type": "array",
"x-expanded": false
},
"manualChoicesIds": {
"description": "Manually added cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Manually added cases",
"type": "array",
"x-expanded": false
},
"frozenSetIds": {
"description": "Frozen cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Frozen cases",
"type": "array",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"population",
"id",
"name",
"description"
],
"title": "Cohort",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/cohorts/{cohortId}¶
Delete Cohort
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/cohorts/{cohortId}¶
Update Cohort
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Request body
{
"includeCriteria": null,
"excludeCriteria": null,
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"projectId": "2613e4f1-fcff-46be-b04c-12127e6ef904",
"casesIds": [
"3ccd9b30-716d-4b4f-80ad-42126c4ba3ce"
],
"manualChoicesIds": [
"03cf0d70-da47-40a6-b43c-60ff23ba8619"
],
"frozenSetIds": [
"d40bda4f-6a4f-4d85-a5df-380b2f4eb901"
]
}
Schema of the request body
{
"description": "Schema for creating a new cohort, including cohort logic definitions.",
"properties": {
"includeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be included in the cohort",
"title": "Inclusion critera"
},
"excludeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be excluded from the cohort",
"title": "Exclusion critera"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"name": {
"description": "Name of the cohort",
"maxLength": 255,
"title": "Cohort name",
"type": "string",
"x-expanded": false
},
"projectId": {
"description": "Project to which the cohort is associated",
"format": "uuid",
"title": "Project",
"type": "string",
"x-expanded": false
},
"casesIds": {
"description": "Cases composing the cohort",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Cases",
"type": "array",
"x-expanded": false
},
"manualChoicesIds": {
"description": "Manually added cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Manually added cases",
"type": "array",
"x-expanded": false
},
"frozenSetIds": {
"description": "Frozen cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Frozen cases",
"type": "array",
"x-expanded": false
}
},
"required": [
"name"
],
"title": "CohortCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/cases¶
Get Cohort Cases
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
cohortId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No |
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"age": null,
"dateOfBirth": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"id": "4ac8233b-58bb-49da-9342-22379ba833da",
"externalSource": "string",
"externalSourceId": "string",
"pseudoidentifier": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/contributors¶
Get Cohort Contributions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/cohorts/{cohortId}/export¶
Export Cohort Definition
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Response 200 OK
{
"exportedAt": "2022-04-13T15:42:05.901Z",
"exportedBy": "string",
"exportVersion": "string",
"checksum": "string",
"definition": {
"includeCriteria": null,
"excludeCriteria": null,
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"projectId": "c8f8fc8a-a644-4cd9-bae2-2c5963562fe3",
"casesIds": [
"c434cc4a-f42d-48e8-b0e5-26ed7e59ce66"
],
"manualChoicesIds": [
"9f68d707-9680-4c2d-a5b0-de7c55201532"
],
"frozenSetIds": [
"6dd7ae16-fc80-4fa3-b05d-4e0e23ff3565"
]
}
}
Schema of the response body
{
"properties": {
"exportedAt": {
"description": "The datetime when the resource was exported.",
"format": "date-time",
"title": "Export Timestamp",
"type": "string"
},
"exportedBy": {
"description": "Username of the user who performed the export.",
"title": "Exported By",
"type": "string"
},
"exportVersion": {
"description": "Version tag of the exporting system.",
"title": "Export Version",
"type": "string"
},
"checksum": {
"description": "Checksum (e.g., SHA256) of the exported content for integrity verification.",
"title": "Export Checksum",
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/CohortCreate",
"description": "The cohort definition",
"title": "Cohort Definition"
}
},
"required": [
"exportedAt",
"exportedBy",
"exportVersion",
"checksum",
"definition"
],
"title": "ExportedCohortDefinition",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/history/events¶
Get All Cohort History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/history/events/{eventId}¶
Get Cohort History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
eventId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/cohorts/{cohortId}/history/events/{eventId}/reversion¶
Revert Cohort To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
eventId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/cohorts/{cohortId}/dataset/{datasetId}/export¶
Export Cohort Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
datasetId |
path | string | No |
Response 200 OK
{
"exportedAt": "2022-04-13T15:42:05.901Z",
"exportedBy": "string",
"exportVersion": "string",
"checksum": "string",
"dataset": [
{
"anonymized": true,
"age": null,
"dateOfBirth": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"id": "5377b601-89bb-4340-8991-56cdb5a8ff5e",
"externalSource": "string",
"externalSourceId": "string",
"pseudoidentifier": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": null,
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"neoplasticEntities": [
{
"anonymized": true,
"topographyGroup": null,
"id": "9aeed112-3cc0-42c2-aba5-1228077d5eb9",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "044e8da9-23fd-4eeb-92d7-554d12ec56ea",
"relationship": null,
"relatedPrimaryId": "aefc3672-87de-442d-a3a3-9e7c8920e245",
"assertionDate": "2022-04-13",
"topography": null,
"morphology": null,
"differentitation": null,
"laterality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tnmStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "20efcad6-4f02-474c-bdab-4ba2f4b200db",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "daed4f40-7b65-4ca7-95a8-5b68b81d0519",
"date": "2022-04-13",
"stagedEntitiesIds": [
"2cb393de-b83f-4215-81b7-7ebff80be933"
],
"stage": null,
"methodology": null,
"pathological": true,
"primarytumor": null,
"regionalnodes": null,
"distantmetastases": null,
"grade": null,
"residualtumor": null,
"lymphaticinvasion": null,
"venousinvasion": null,
"perineuralinvasion": null,
"serumtumormarkerlevel": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"figoStagings": null,
"binetStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "9a5a7528-cec3-4c2b-92d7-4385ff23b341",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ecab5c7a-7b8e-4a0c-a910-0ecffd45ed15",
"date": "2022-04-13",
"stagedEntitiesIds": [
"7cb94360-1da2-477f-abda-1052bfca5323"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"raiStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "b52628f8-0f34-44a4-9d7d-11fb28c5aecc",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a36ba3ec-c062-4ea0-92bb-f15cf67e58ea",
"date": "2022-04-13",
"stagedEntitiesIds": [
"dd3c8e49-be1b-4c41-8893-b5cd90db20a9"
],
"stage": null,
"methodology": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"breslowStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"stage": null,
"id": "2c9a1202-2a0c-4e36-b630-d6bd562e38a9",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "8227e648-12e7-499d-92c2-7f60f9741bc6",
"date": "2022-04-13",
"stagedEntitiesIds": [
"373c709a-b749-4bdb-a697-ebd100dae2e3"
],
"depth": null,
"isUlcered": true,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"clarkStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "cf441287-40e7-40cc-96d5-449399d14661",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "236e683d-782a-4ac0-9fa1-9a6a2fd2a983",
"date": "2022-04-13",
"stagedEntitiesIds": [
"fa891bba-0950-4e5b-aac7-df9ce77edcc6"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"issStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "86c187c3-3c49-4a38-89c8-bedc11d27a37",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "39bab106-241e-41f6-b19e-5ed72fcac751",
"date": "2022-04-13",
"stagedEntitiesIds": [
"f449b435-4e4d-4f5d-b217-e05aac84b9c4"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"rissStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "c6711dea-9c19-40d4-960d-043a9215b98a",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f555ca1b-2c35-47cb-99af-2288e67c74e8",
"date": "2022-04-13",
"stagedEntitiesIds": [
"4e7175c9-6a21-4ef8-942f-51341b1dad20"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"inssStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "a78b941e-8215-4c9e-aa05-729f3e03e566",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e5b28f06-3be2-4342-86b1-1e917b4b81a5",
"date": "2022-04-13",
"stagedEntitiesIds": [
"d240b50d-ba0c-49fd-9c83-8dd30e8ebf5b"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"inrgssStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "65d2f227-5369-4093-b22d-1b532002eb49",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "21dfbbd6-6ec3-4970-8869-81389e5f88b2",
"date": "2022-04-13",
"stagedEntitiesIds": [
"7c9567ce-8687-4b6b-8643-de3de90aefa3"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"gleasonStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "7915fa84-2c64-434c-b4d2-a87fc1863c61",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "1a64556d-779d-4666-8ad1-32fabaa7ca5a",
"date": "2022-04-13",
"stagedEntitiesIds": [
"c863eaeb-4e20-4f51-bcbf-312133d7959c"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"rhabdomyosarcomaGroups": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "cf864900-2b41-4110-b77e-0a465122bc8b",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "065c6601-08e1-402c-9d1e-970e1a9094be",
"date": "2022-04-13",
"stagedEntitiesIds": [
"ab39e8a7-93ec-45ec-91c1-2b95b698747a"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"wilmsStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "0f8b5893-2c86-462b-ad3d-cf18a84956c3",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f7817211-b679-4ea3-bc4b-0c66b61dea92",
"date": "2022-04-13",
"stagedEntitiesIds": [
"1c85b6ef-29df-46ee-8e5d-93d8532ecae5"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"lymphomaStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "d3e91e6e-ecbb-467d-afdf-e9bd3d92e654",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c820bb83-b195-447a-bc90-fd3b8ad4b46e",
"date": "2022-04-13",
"stagedEntitiesIds": [
"de3a810a-82f9-42d8-82bf-aba0a6fbb19d"
],
"stage": null,
"methodology": null,
"bulky": true,
"pathological": true,
"modifiers": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tumorMarkers": [
{
"anonymized": true,
"id": "c527b05a-cc71-438d-b259-efb6e5dfc13e",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "38578daa-2b72-4bf2-a7a1-740fbf84b434",
"date": "2022-04-13",
"analyte": null,
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"84fbb296-ab5e-43b9-8e9a-bd6aed109533"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"riskAssessments": [
{
"anonymized": true,
"id": "c47ac1c2-9376-4761-aa9d-975f524396c0",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2aba9874-959a-43d0-93ae-1a01608b3aa0",
"date": "2022-04-13",
"methodology": null,
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"d8b8faaf-57b4-4ad9-b0e5-e43a63f23d72"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"therapyLines": [
{
"anonymized": true,
"period": "string",
"label": "string",
"progressionFreeSurvival": 10.12,
"id": "b82b7a29-3d13-40af-9ee0-e229c5ca9a8b",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f1f892e3-f234-4517-8630-8b7f1b13a3e6",
"ordinal": 0,
"intent": null,
"progressionDate": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"systemicTherapies": [
{
"anonymized": true,
"medications": [
{
"id": "cfc7b084-423a-489f-86ef-36c4905b83bc",
"externalSource": "string",
"externalSourceId": "string",
"drug": null,
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"duration": null,
"id": "7401226e-426b-4fc1-862b-a6ef59f6c2f6",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "1d86feaf-e965-4bae-891d-80d6734cd975",
"period": "string",
"cycles": 0,
"intent": null,
"adjunctiveRole": null,
"isAdjunctive": true,
"terminationReason": null,
"therapyLineId": "cff3fa9d-370d-4b0e-b34c-c9d2ba64620d",
"targetedEntitiesIds": [
"7bd6ab8b-1b91-4cfb-b5e0-1808363d7805"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"surgeries": [
{
"anonymized": true,
"id": "0636542b-481b-4700-b3a2-36e69da0ea7b",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "3c424624-5a06-40ef-a77b-15da31fb2fcf",
"date": "2022-04-13",
"procedure": null,
"intent": null,
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "ac708069-4502-4d29-836b-ef7574af5105",
"targetedEntitiesIds": [
"f32efcd6-2466-45c2-954a-4d1b25e9c5d3"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"radiotherapies": [
{
"anonymized": true,
"duration": null,
"dosages": [
{
"id": "dc499683-1461-418b-ba88-9aa0613e7fbf",
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": null,
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"settings": [
{
"id": "29c6ed1a-8ea5-490f-862a-6058ba624e6d",
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "efe9785c-d141-40ef-8761-e5c299aec3b9",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "07b1f478-6284-48f0-9b7f-ca9dde065ea7",
"period": "string",
"sessions": 0,
"intent": null,
"terminationReason": null,
"therapyLineId": "f66edea0-94e0-4333-ad5a-e8db9ad4f637",
"targetedEntitiesIds": [
"9e6f4649-9f53-4de4-8ca6-a777000ec284"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"adverseEvents": [
{
"anonymized": true,
"suspectedCauses": [
{
"id": "b39b0c96-8f4e-4acc-b127-0cade977c54e",
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "6c46e9de-5a10-4a1e-b77d-e97f812fd706",
"medicationId": "00ff5a14-82a7-4a4e-88a9-fe25abaa70d6",
"radiotherapyId": "0fd0987d-a809-41d4-8f8a-ca9b2c016949",
"surgeryId": "4fc7e31d-7294-4acb-a844-3066686816f1",
"causality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"mitigations": [
{
"id": "073a0f6e-cc6e-4d63-a05d-554713e53516",
"externalSource": "string",
"externalSourceId": "string",
"category": null,
"adjustment": null,
"drug": null,
"procedure": null,
"management": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "b2e0abec-c794-4993-947d-c0262fc0a163",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "bacd7697-ec79-4e17-af17-939390122d04",
"date": "2022-04-13",
"event": null,
"grade": 0,
"outcome": null,
"dateResolved": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"treatmentResponses": [
{
"anonymized": true,
"id": "3436f94f-9a07-4379-9019-46303ecaa7e4",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "aa440b1e-d772-47dd-b6fa-a71cff55bffd",
"date": "2022-04-13",
"recist": null,
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"e3e5b2cc-db3d-41bf-bf8e-63e457add765"
],
"assessedBodysites": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"performanceStatus": [
{
"anonymized": true,
"ecogInterpretation": null,
"karnofskyInterpretation": null,
"id": "49e21514-0008-4714-842d-c910a419a514",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "06a112e9-23a7-4481-8803-0c6115df220a",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"comorbidities": [
{
"anonymized": true,
"score": null,
"id": "517407e8-9453-44a9-b5d6-7269371ddfc6",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "022ccfb8-3259-4247-8d75-95331305db38",
"date": "2022-04-13",
"indexConditionId": "98cb652a-1cc8-4efb-9a49-8c39d647bbbc",
"panel": null,
"presentConditions": null,
"absentConditions": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"genomicVariants": [
{
"anonymized": true,
"isPathogenic": true,
"isVUS": true,
"dnaHgvs": "string",
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaHgvs": "string",
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinHgvs": "string",
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
],
"id": "5e81aad7-87b4-42b2-a9cc-cc51ac507a64",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "580496b6-1e10-4711-af3f-1e6d30737ca7",
"date": "2022-04-13",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"genes": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tumorMutationalBurdens": [
{
"anonymized": true,
"category": "string",
"id": "cdd69c3f-afed-4b8b-ad68-0e833358244e",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c5fa493d-3ee0-4fbb-8847-5682672c0a8b",
"date": "2022-04-13",
"value": 10.12,
"status": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"microsatelliteInstabilities": [
{
"anonymized": true,
"category": "string",
"id": "31b19960-83e9-4fb4-8a2d-ca02b2cd6754",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "baba4c76-711a-4f2d-892c-4b164afa9624",
"date": "2022-04-13",
"value": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"lossesOfHeterozygosity": [
{
"anonymized": true,
"category": "string",
"id": "bffdddf3-76e1-4ed1-904e-87c4050a59a2",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "575560b7-6876-41b5-91af-fc98cb8f30b8",
"date": "2022-04-13",
"value": 10.12,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"homologousRecombinationDeficiencies": [
{
"anonymized": true,
"category": "string",
"id": "cf672233-c60d-4640-9df0-38dc94a581dc",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5ca28b5b-8834-49ba-8a5f-f29d1ab3cd08",
"date": "2022-04-13",
"value": 10.12,
"interpretation": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tumorNeoantigenBurdens": [
{
"anonymized": true,
"category": "string",
"id": "8b7bd190-e4a9-4ba8-8816-0616fce11935",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5c7594e2-91f2-4bab-a040-8c0619d66024",
"date": "2022-04-13",
"value": 10.12,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"aneuploidScores": [
{
"anonymized": true,
"category": "string",
"id": "fec28ff1-7aa8-4add-9aee-413db6d06929",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ab3a48e8-9b15-40ff-8c65-7fd7e88f2d28",
"date": "2022-04-13",
"value": 0,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"vitals": [
{
"anonymized": true,
"bodyMassIndex": null,
"id": "303134ef-79fc-41dc-9722-cdcd0e0d7f47",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d133ebf9-2871-41ec-9f44-e38bb5982cf2",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"lifestyles": [
{
"anonymized": true,
"id": "7af9f4e5-9a00-44be-a0bf-4685e3ca42b9",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6bb34b49-3e26-4133-8a63-7f783747610d",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": null,
"exposures": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"familyHistory": [
{
"anonymized": true,
"id": "044678e9-c3e8-4de7-8375-9555aa8593f5",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "bbdf7e39-9f54-4a08-bf9d-612ba7687943",
"date": "2022-04-13",
"relationship": null,
"hadCancer": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"unspecifiedTumorBoards": [
{
"anonymized": true,
"category": "string",
"id": "638f8fb6-15c2-4cd9-907c-c2fc0787342b",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f55a1a21-4c26-435d-ae8c-1d0f39c8b8a3",
"date": "2022-04-13",
"relatedEntitiesIds": [
"3b43cc5e-52b1-469c-bd6d-4f0018958b32"
],
"recommendations": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"molecularTumorBoards": null
}
]
}
Schema of the response body
{
"properties": {
"exportedAt": {
"description": "The datetime when the resource was exported.",
"format": "date-time",
"title": "Export Timestamp",
"type": "string"
},
"exportedBy": {
"description": "Username of the user who performed the export.",
"title": "Exported By",
"type": "string"
},
"exportVersion": {
"description": "Version tag of the exporting system.",
"title": "Export Version",
"type": "string"
},
"checksum": {
"description": "Checksum (e.g., SHA256) of the exported content for integrity verification.",
"title": "Export Checksum",
"type": "string"
},
"dataset": {
"description": "The dataset that was exported",
"items": {
"$ref": "#/components/schemas/PatientCaseDataset"
},
"title": "Dataset",
"type": "array"
}
},
"required": [
"exportedAt",
"exportedBy",
"exportVersion",
"checksum",
"dataset"
],
"title": "ExportedPatientCaseDataset",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/cohorts/{cohortId}/dataset¶
Construct Cohort Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 200 OK
{
"count": 0,
"items": [
{
"anonymized": true,
"age": null,
"dateOfBirth": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"id": "9263dd66-14a9-482d-a732-62d7d78f36f3",
"externalSource": "string",
"externalSourceId": "string",
"pseudoidentifier": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": null,
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"neoplasticEntities": [
{
"anonymized": true,
"topographyGroup": null,
"id": "bf0ce429-859a-49fd-8ac1-111291961763",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c7c05f44-199b-4615-9ea3-7dac61b61783",
"relationship": null,
"relatedPrimaryId": "27062a93-019a-4b92-9339-51863b92af3d",
"assertionDate": "2022-04-13",
"topography": null,
"morphology": null,
"differentitation": null,
"laterality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tnmStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "9d2ab2cf-5b7c-42e1-9e08-3d9e4b659285",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "003136af-8940-4e4f-800d-2bd844a2a70b",
"date": "2022-04-13",
"stagedEntitiesIds": [
"a07b23ae-cad7-48e4-85b7-7b739bd00932"
],
"stage": null,
"methodology": null,
"pathological": true,
"primarytumor": null,
"regionalnodes": null,
"distantmetastases": null,
"grade": null,
"residualtumor": null,
"lymphaticinvasion": null,
"venousinvasion": null,
"perineuralinvasion": null,
"serumtumormarkerlevel": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"figoStagings": null,
"binetStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "2fe34eaf-f208-4ea8-8fac-11aa57b345e8",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "89879fbd-7b62-4250-bc96-4e350f0dcf49",
"date": "2022-04-13",
"stagedEntitiesIds": [
"2a61d575-9c89-4ffe-b3f6-eb60ed54a116"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"raiStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "baaba6e5-e236-491d-81c4-5cec82289895",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "cda2bf1e-e139-443b-a52d-be2e58f2f52e",
"date": "2022-04-13",
"stagedEntitiesIds": [
"892880ab-131a-4964-ae71-15fc3818e111"
],
"stage": null,
"methodology": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"breslowStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"stage": null,
"id": "1b0e628d-0840-42d0-af80-782ee09b3cb8",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d1199fb1-a17f-44de-b1a7-d74d81e6d638",
"date": "2022-04-13",
"stagedEntitiesIds": [
"1536ca38-f1f4-4a11-b366-ba385aa44717"
],
"depth": null,
"isUlcered": true,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"clarkStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "6b47cf75-a88f-4c70-bd0c-0be9f7b06990",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "bb686f1f-b526-48d1-bd02-47a4a12a53cc",
"date": "2022-04-13",
"stagedEntitiesIds": [
"31953d34-e305-479e-ba4c-322207138e77"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"issStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "023cf7d5-92c1-4b34-8787-04c93063079c",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "3218372c-077b-4e6b-ad54-f9864724802d",
"date": "2022-04-13",
"stagedEntitiesIds": [
"36685d79-07e3-495d-b615-c8fbb4a30208"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"rissStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "d6cce3e4-a964-4fb7-9723-fd57dba03687",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "52551588-c684-46f2-bd7e-c7e669128f22",
"date": "2022-04-13",
"stagedEntitiesIds": [
"bc60c8b9-00b9-4143-a668-770e91fde182"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"inssStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "995a9ead-9414-4f5b-935e-e19c65dfccbf",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "44221ca3-0943-4adc-b690-b4aaadb6f3e0",
"date": "2022-04-13",
"stagedEntitiesIds": [
"a088665e-aa1d-44bf-8d85-302f38eb0cd5"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"inrgssStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "b9ebbf81-26c9-447e-9f13-594ef1b4b4ef",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "347a5928-8437-4bf8-a6e5-57b1c4de71ec",
"date": "2022-04-13",
"stagedEntitiesIds": [
"1e40b743-ee24-4899-8de8-4ecc522150ee"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"gleasonStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "3add4901-5543-4c28-a397-36422f350815",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fc6b5226-9ae3-45dc-9e5e-2df8e12e3803",
"date": "2022-04-13",
"stagedEntitiesIds": [
"32a5988f-d0a8-4755-bf08-baa4aef8826d"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"rhabdomyosarcomaGroups": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "2f61c584-a5bf-41dd-a5a2-243fda261388",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ad4d4d43-bb68-421f-840c-1b712d7223e7",
"date": "2022-04-13",
"stagedEntitiesIds": [
"c8c2e8a0-5af1-481b-b10c-4513cd00fbba"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"wilmsStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "bb45ebba-4b29-4de9-a85e-470ab1b606f3",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "592e3488-e5da-4c35-89f3-a172bc225100",
"date": "2022-04-13",
"stagedEntitiesIds": [
"796be090-33de-4554-997a-7d158871b3c8"
],
"stage": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"lymphomaStagings": [
{
"anonymized": true,
"stagingDomain": "string",
"id": "a004d054-aa34-4d5e-9833-5f7d074a3435",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "70355281-0a28-4376-82fc-f2cc770a599d",
"date": "2022-04-13",
"stagedEntitiesIds": [
"a5eeff42-0dfd-47d4-8930-54f59c79e4d6"
],
"stage": null,
"methodology": null,
"bulky": true,
"pathological": true,
"modifiers": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tumorMarkers": [
{
"anonymized": true,
"id": "5ec11d24-0bfa-492d-abf4-ea7e5d627f97",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fc9cf49d-3733-40b4-bfb0-789bf703651d",
"date": "2022-04-13",
"analyte": null,
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"a288f1a1-d9e9-4c03-a1e5-2ee6bd290358"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"riskAssessments": [
{
"anonymized": true,
"id": "24f41243-8ecf-4bfc-a02c-e4d7b7d96df2",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "eae921a1-b58d-4449-b364-5281c7109da7",
"date": "2022-04-13",
"methodology": null,
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"401301ec-1eba-4a09-9aca-4785fe5d67e8"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"therapyLines": [
{
"anonymized": true,
"period": "string",
"label": "string",
"progressionFreeSurvival": 10.12,
"id": "3f3faa15-4b6b-47e0-a60c-cc7f290cc0af",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "04ac24af-1bae-4f0c-9090-8241ce7e6736",
"ordinal": 0,
"intent": null,
"progressionDate": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"systemicTherapies": [
{
"anonymized": true,
"medications": [
{
"id": "dd2453ee-8424-474c-9eb4-7c367815f448",
"externalSource": "string",
"externalSourceId": "string",
"drug": null,
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"duration": null,
"id": "e3c1903a-788c-47ba-b976-b59de789085c",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "3cbaa178-b9d3-45e4-884e-25ff200043b1",
"period": "string",
"cycles": 0,
"intent": null,
"adjunctiveRole": null,
"isAdjunctive": true,
"terminationReason": null,
"therapyLineId": "d579c1d8-b1e9-4c13-bedb-f32c45e253f9",
"targetedEntitiesIds": [
"7ef415a4-cc8c-4b28-b3b4-69b574f2d07d"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"surgeries": [
{
"anonymized": true,
"id": "97f63471-6f2f-4300-95fe-84d58f0f4ca7",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "246b7b74-6849-4235-b13c-73ba8198b30a",
"date": "2022-04-13",
"procedure": null,
"intent": null,
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "71a73e72-15d4-4641-87a8-097f6e711781",
"targetedEntitiesIds": [
"5bc12d81-0df5-49b3-99c1-a751314cf1a5"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"radiotherapies": [
{
"anonymized": true,
"duration": null,
"dosages": [
{
"id": "d11125f6-ca96-4ebf-aa90-7c411b1d82dc",
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": null,
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"settings": [
{
"id": "435f8613-c583-4485-9b0a-55fa2ed64635",
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "c865b88b-1169-4834-81b9-23c7b3ed6711",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "43cdd17a-9dc8-4005-a750-4931096e1d39",
"period": "string",
"sessions": 0,
"intent": null,
"terminationReason": null,
"therapyLineId": "d8d1fd7f-057e-4b9c-8dac-a94f962c2ca3",
"targetedEntitiesIds": [
"28545caa-a121-4956-b4b0-844d86dcdf5d"
],
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"adverseEvents": [
{
"anonymized": true,
"suspectedCauses": [
{
"id": "0eeca1a7-00c0-4f19-8030-dc3dda35e52a",
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "0b158094-2fb4-4b01-b250-7b6f7da7c9d1",
"medicationId": "e0fc1f69-ae86-4cbb-ab8a-9327edcba53f",
"radiotherapyId": "61f7ef06-d690-4135-b723-9c9089d1d0b8",
"surgeryId": "adddf71b-eff1-472f-baf2-8a4b6dfcb460",
"causality": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"mitigations": [
{
"id": "d977e459-c1b5-4257-b464-3df78fce93c9",
"externalSource": "string",
"externalSourceId": "string",
"category": null,
"adjustment": null,
"drug": null,
"procedure": null,
"management": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"id": "775d6e78-7074-4c0b-bc22-e16a21d821b3",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ed80f6c3-be9a-4ec7-9c81-ff7bfb1554a4",
"date": "2022-04-13",
"event": null,
"grade": 0,
"outcome": null,
"dateResolved": "2022-04-13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"treatmentResponses": [
{
"anonymized": true,
"id": "081a4060-b837-4d81-92a4-50fe6a0dfb2d",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "13b0f437-a9fd-4547-a122-8456d1b26c47",
"date": "2022-04-13",
"recist": null,
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"45c5840a-6472-443b-81f3-3152f94d6c73"
],
"assessedBodysites": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"performanceStatus": [
{
"anonymized": true,
"ecogInterpretation": null,
"karnofskyInterpretation": null,
"id": "7fd634b8-ab82-4b2f-a0f0-ba0948e0c398",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "4a03f271-e6ef-43d1-9606-65db431a7629",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"comorbidities": [
{
"anonymized": true,
"score": null,
"id": "9a05fd84-b8b8-446b-88a6-a8cee147c7ab",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f1a1b4a4-9a3a-4e40-b699-da0076f530fa",
"date": "2022-04-13",
"indexConditionId": "4e858791-78c1-4442-be8c-9ba103cd06bd",
"panel": null,
"presentConditions": null,
"absentConditions": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"genomicVariants": [
{
"anonymized": true,
"isPathogenic": true,
"isVUS": true,
"dnaHgvs": "string",
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaHgvs": "string",
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinHgvs": "string",
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
],
"id": "06b95d2f-5890-41b1-9303-a85732ac5cfa",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "62376cf9-cbe2-41d9-8793-06dd8ebb73af",
"date": "2022-04-13",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"genes": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tumorMutationalBurdens": [
{
"anonymized": true,
"category": "string",
"id": "1e199f64-7a07-4568-b4c6-b4d55a28a771",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "df68ab37-39bb-4eae-9d3e-feeac953881a",
"date": "2022-04-13",
"value": 10.12,
"status": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"microsatelliteInstabilities": [
{
"anonymized": true,
"category": "string",
"id": "717b53aa-8b1f-4746-9e53-7cb6c8f8f1cd",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "65990fb3-6370-4e33-802a-4dd3068e3cb0",
"date": "2022-04-13",
"value": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"lossesOfHeterozygosity": [
{
"anonymized": true,
"category": "string",
"id": "eedb9944-ac7a-437f-b696-07bc5f927f3c",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "8a94538e-a24d-4c57-9784-4fa22712f5ea",
"date": "2022-04-13",
"value": 10.12,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"homologousRecombinationDeficiencies": [
{
"anonymized": true,
"category": "string",
"id": "242f58a8-c009-4323-83f4-3b97a76e372c",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d0261b5f-91c2-45c2-b6cf-6ddf3f88115c",
"date": "2022-04-13",
"value": 10.12,
"interpretation": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"tumorNeoantigenBurdens": [
{
"anonymized": true,
"category": "string",
"id": "246a54ff-774c-4033-be99-515fda1c77ab",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0caaaf3b-53ca-4e27-bd8b-60698f0063f2",
"date": "2022-04-13",
"value": 10.12,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"aneuploidScores": [
{
"anonymized": true,
"category": "string",
"id": "381e34ff-b84a-4261-b114-d5f6ac9366a0",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "58b8d315-e833-4c87-a0e8-064b77acd2dc",
"date": "2022-04-13",
"value": 0,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"vitals": [
{
"anonymized": true,
"bodyMassIndex": null,
"id": "b99dc85b-4a3c-44ed-b168-b451ee459ba0",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "39e7fd55-df55-4a2b-a645-39f9b2804b1d",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"lifestyles": [
{
"anonymized": true,
"id": "28d39de8-0237-43d3-90cc-4195cf028146",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5873abe9-2782-4f89-ac42-9aa718ec75e5",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": null,
"exposures": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"familyHistory": [
{
"anonymized": true,
"id": "a7a6a8dd-9eea-4af6-8bbd-91a636e687b0",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "1d0385d9-dc40-4599-8bf6-9a24e8513956",
"date": "2022-04-13",
"relationship": null,
"hadCancer": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"unspecifiedTumorBoards": [
{
"anonymized": true,
"category": "string",
"id": "c62034fa-35b6-4beb-bc70-2ff59b82dcaf",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "3d176b1a-0333-4948-a568-25ebb339ac6d",
"date": "2022-04-13",
"relatedEntitiesIds": [
"fbdb49ee-05e4-4bf7-a3b9-5131535baf36"
],
"recommendations": null,
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
],
"molecularTumorBoards": null
}
]
}
Schema of the response body
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/traits¶
Get Cohort Traits Statistics
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Response 200 OK
{
"age": {
"median": null,
"interQuartalRange": null
},
"dataCompletion": null,
"overallSurvival": null,
"genders": [
{
"category": "string",
"counts": 0,
"percentage": 10.12
}
],
"neoplasticSites": null,
"therapyLines": null,
"consentStatus": null
}
Schema of the response body
{
"properties": {
"age": {
"$ref": "#/components/schemas/CohortTraitMedian",
"description": "Median age of individuals in the cohort.",
"title": "Age"
},
"dataCompletion": {
"$ref": "#/components/schemas/CohortTraitMedian",
"description": "Median percentage of completed data per patient.",
"title": "Data Completion"
},
"overallSurvival": {
"$ref": "#/components/schemas/CohortTraitMedian",
"description": "Median overall survival time in the cohort, if available.",
"title": "Overall Survival"
},
"genders": {
"description": "Distribution of genders within the cohort.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Genders",
"type": "array"
},
"neoplasticSites": {
"description": "Distribution of neoplastic (tumor) sites in the cohort.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Neoplastic Sites",
"type": "array"
},
"therapyLines": {
"description": "Distribution of therapy lines received by patients in the cohort.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Therapy Lines",
"type": "array"
},
"consentStatus": {
"description": "Distribution of consent statuses for data use among cohort participants.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Consent Status",
"type": "array"
}
},
"required": [
"age",
"dataCompletion",
"overallSurvival",
"genders",
"neoplasticSites",
"therapyLines",
"consentStatus"
],
"title": "CohortTraits",
"type": "object"
}
Response 404 Not Found
Response 422 Unprocessable Entity
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Data Analysis¶
GET /api/v1/cohorts/{cohortId}/analysis/distribution¶
Get Cohort Property Distribution
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
property |
query | string | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"items": {
"description": "The entries in the distribution.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Items",
"type": "array"
}
},
"required": [
"items"
],
"title": "Distribution",
"type": "object"
}
Response 404 Not Found
Response 422 Unprocessable Entity
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/analysis/overall-survical/kaplan-meier¶
Get Cohort Overall Survival Curve
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
confidence |
query | number | 0.95 | No |
Response 200 OK
{
"metadata": null,
"months": [
10.12
],
"probabilities": [
10.12
],
"lowerConfidenceBand": [
10.12
],
"upperConfidenceBand": [
10.12
]
}
Schema of the response body
{
"description": "Kaplan-Meier survival curve",
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"months": {
"description": "List of time points (in months) for survival probability estimates.",
"items": {
"type": "number"
},
"title": "Months",
"type": "array"
},
"probabilities": {
"description": "Survival probabilities at each time point.",
"items": {
"type": "number"
},
"title": "Probabilities",
"type": "array"
},
"lowerConfidenceBand": {
"description": "Lower bound of the survival probability confidence interval at each time point.",
"items": {
"type": "number"
},
"title": "Lower Confidence Band",
"type": "array"
},
"upperConfidenceBand": {
"description": "Upper bound of the survival probability confidence interval at each time point.",
"items": {
"type": "number"
},
"title": "Upper Confidence Band",
"type": "array"
}
},
"required": [
"months",
"probabilities",
"lowerConfidenceBand",
"upperConfidenceBand"
],
"title": "KaplanMeierCurve",
"type": "object"
}
Response 404 Not Found
Response 422 Unprocessable Entity
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/analysis/oncoplot¶
Get Cohort Oncoplot Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Response 200 OK
{
"metadata": null,
"genes": [
"string"
],
"cases": [
"string"
],
"variants": [
{
"gene": "string",
"caseId": "string",
"hgvsExpression": "string",
"isPathogenic": true
}
]
}
Schema of the response body
{
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"genes": {
"description": "List of most frequently encountered genes",
"items": {
"type": "string"
},
"title": "Genes",
"type": "array"
},
"cases": {
"description": "List of patient cases",
"items": {
"type": "string"
},
"title": "Cases",
"type": "array"
},
"variants": {
"description": "Variants included in the Oncoplot",
"items": {
"$ref": "#/components/schemas/OncoplotVariant"
},
"title": "Variants",
"type": "array"
}
},
"required": [
"genes",
"cases",
"variants"
],
"title": "OncoplotDataset",
"type": "object"
}
Response 404 Not Found
Response 422 Unprocessable Entity
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/progression-free-survival/kaplan-meier¶
Get Cohort Line Progression Free Survival Curve
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
confidence |
query | number | 0.95 | No | |
therapyLine |
path | string | No |
Response 200 OK
{
"metadata": null,
"months": [
10.12
],
"probabilities": [
10.12
],
"lowerConfidenceBand": [
10.12
],
"upperConfidenceBand": [
10.12
]
}
Schema of the response body
{
"description": "Kaplan-Meier survival curve",
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"months": {
"description": "List of time points (in months) for survival probability estimates.",
"items": {
"type": "number"
},
"title": "Months",
"type": "array"
},
"probabilities": {
"description": "Survival probabilities at each time point.",
"items": {
"type": "number"
},
"title": "Probabilities",
"type": "array"
},
"lowerConfidenceBand": {
"description": "Lower bound of the survival probability confidence interval at each time point.",
"items": {
"type": "number"
},
"title": "Lower Confidence Band",
"type": "array"
},
"upperConfidenceBand": {
"description": "Upper bound of the survival probability confidence interval at each time point.",
"items": {
"type": "number"
},
"title": "Upper Confidence Band",
"type": "array"
}
},
"required": [
"months",
"probabilities",
"lowerConfidenceBand",
"upperConfidenceBand"
],
"title": "KaplanMeierCurve",
"type": "object"
}
Response 404 Not Found
Response 422 Unprocessable Entity
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/progression-free-survivals/categories¶
Get Cohort Line Progression Free Survival By Categories
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
categorization |
query | None | No | ||
cohortId |
path | string | No | ||
therapyLine |
path | string | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"survivals": {
"additionalProperties": {
"items": {
"type": "number"
},
"type": "array"
},
"title": "Survivals",
"type": "object"
}
},
"required": [
"survivals"
],
"title": "CategorizedSurvivals",
"type": "object"
}
Response 404 Not Found
Response 422 Unprocessable Entity
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/distribution¶
Get Cohort Line Property Distribution
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
property |
query | string | No | ||
therapyLine |
path | string | No |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"items": {
"description": "The entries in the distribution.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Items",
"type": "array"
}
},
"required": [
"items"
],
"title": "Distribution",
"type": "object"
}
Response 404 Not Found
Response 422 Unprocessable Entity
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Dashboard¶
GET /api/v1/dashboard/stats¶
Get Full Cohort Statistics
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"cases": 0,
"primarySites": 0,
"projects": 0,
"cohorts": 0,
"entries": 0,
"mutations": 0,
"clinicalCenters": 0,
"contributors": 0
}
Schema of the response body
{
"properties": {
"cases": {
"description": "Total number of unique patient cases in the data platform.",
"title": "Patient Cases",
"type": "integer"
},
"primarySites": {
"description": "Number of distinct primary anatomical sites represented.",
"title": "Primary Sites",
"type": "integer"
},
"projects": {
"description": "Total number of research projects.",
"title": "Projects",
"type": "integer"
},
"cohorts": {
"description": "Number of defined cohorts in the platform.",
"title": "Cohorts",
"type": "integer"
},
"entries": {
"description": "Total number of individual data entries recorded.",
"title": "Data Entries",
"type": "integer"
},
"mutations": {
"description": "Total number of genetic mutations documented across all cases.",
"title": "Mutations",
"type": "integer"
},
"clinicalCenters": {
"description": "Number of clinical centers contributing data.",
"title": "Clinical Centers",
"type": "integer"
},
"contributors": {
"description": "Total number of individual data contributors.",
"title": "Contributors",
"type": "integer"
}
},
"required": [
"cases",
"primarySites",
"projects",
"cohorts",
"entries",
"mutations",
"clinicalCenters",
"contributors"
],
"title": "DataPlatformStatistics",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/dashboard/primary-site-stats¶
Get Primary Site Statistics
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Response 200 OK
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/dashboard/cases-over-time¶
Get Cases Over Time
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/dashboard/data-completion-stats¶
Get Data Completion Statistics
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"totalCases": 0,
"overallCompletion": 10.12,
"mostIncompleteCategories": [
{
"category": "string",
"cases": 0,
"affectedSites": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
]
}
],
"completionOverTime": [
{
"month": "2022-04-13",
"cumulativeCount": 0
}
]
}
Schema of the response body
{
"properties": {
"totalCases": {
"description": "Total number of patient cases analyzed for data completeness.",
"title": "Total Cases",
"type": "integer"
},
"overallCompletion": {
"description": "Overall percentage of data categories completed across all cases.",
"title": "Overall Completion (%)",
"type": "number"
},
"mostIncompleteCategories": {
"description": "List of the most common categories with missing data.",
"items": {
"$ref": "#/components/schemas/IncompleteCategory"
},
"title": "Most Incomplete Categories",
"type": "array"
},
"completionOverTime": {
"description": "Historical trend of cumulative data completeness by month.",
"items": {
"$ref": "#/components/schemas/CountsPerMonth"
},
"title": "Completion Over Time",
"type": "array"
}
},
"required": [
"totalCases",
"overallCompletion",
"mostIncompleteCategories",
"completionOverTime"
],
"title": "DataCompletionStatistics",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Datasets¶
GET /api/v1/datasets¶
Get All Datasets Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortsIds |
query | string | No | Cohorts - Filter for full text matches | |
cohortsIds.anyOf |
query | array | No | Cohorts - Filter for entries where at least one reference matches the query | |
cohortsIds.beginsWith |
query | string | No | Cohorts - Filter for entries starting with the text | |
cohortsIds.contains |
query | string | No | Cohorts - Filter for partial text matches | |
cohortsIds.endsWith |
query | string | No | Cohorts - Filter for entries ending with the text | |
cohortsIds.not |
query | string | No | Cohorts - Filter for full text mismatches | |
cohortsIds.not.anyOf |
query | array | No | Cohorts - Filter for entries where at least one reference mismatches the query | |
cohortsIds.not.beginsWith |
query | string | No | Cohorts - Filter for entries not starting with the text | |
cohortsIds.not.contains |
query | string | No | Cohorts - Filter for partial text mismatches | |
cohortsIds.not.endsWith |
query | string | No | Cohorts - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
createdBy |
query | string | No | Filter datasets by the creator's username. | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
lastExport.after |
query | string | No | Last Export - Filter for entries with dates after the specified value | |
lastExport.before |
query | string | No | Last Export - Filter for entries with dates before the specified value | |
lastExport.between |
query | array | No | Last Export - Filter for entries with dates between two specified values (inclusive) | |
lastExport.exists |
query | boolean | No | Last Export - Filter for entries with a value | |
lastExport.not.between |
query | array | No | Last Export - Filter for entries with dates not between two specified values (inclusive) | |
lastExport.not.exists |
query | boolean | No | Last Export - Filter for entries without a value | |
lastExport.not.on |
query | string | No | Last Export - Filter for entries with dates not matching the specified value | |
lastExport.on |
query | string | No | Last Export - Filter for entries with dates exactly matching the specified value | |
lastExport.onOrAfter |
query | string | No | Last Export - Filter for entries with dates on or after the specified value | |
lastExport.onOrBefore |
query | string | No | Last Export - Filter for entries with dates on or before the specified value | |
limit |
query | integer | 10 | No | |
name |
query | string | No | Dataset name - Filter for full text matches | |
name.anyOf |
query | array | No | Dataset name - Filter for entries where at least one reference matches the query | |
name.beginsWith |
query | string | No | Dataset name - Filter for entries starting with the text | |
name.contains |
query | string | No | Dataset name - Filter for partial text matches | |
name.endsWith |
query | string | No | Dataset name - Filter for entries ending with the text | |
name.not |
query | string | No | Dataset name - Filter for full text mismatches | |
name.not.anyOf |
query | array | No | Dataset name - Filter for entries where at least one reference mismatches the query | |
name.not.beginsWith |
query | string | No | Dataset name - Filter for entries not starting with the text | |
name.not.contains |
query | string | No | Dataset name - Filter for partial text mismatches | |
name.not.endsWith |
query | string | No | Dataset name - Filter for entries not ending with the text | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No | ||
projectId |
query | string | No | Project - Filter for reference matches | |
projectId.anyOf |
query | array | No | Project - Filter for entries where at least one reference matches the query | |
projectId.beginsWith |
query | string | No | Project - Filter for entries starting with the text | |
projectId.contains |
query | string | No | Project - Filter for partial text matches | |
projectId.endsWith |
query | string | No | Project - Filter for entries ending with the text | |
projectId.not |
query | string | No | Project - Filter for reference mismatches | |
projectId.not.anyOf |
query | array | No | Project - Filter for entries where at least one reference mismatches the query | |
projectId.not.beginsWith |
query | string | No | Project - Filter for entries not starting with the text | |
projectId.not.contains |
query | string | No | Project - Filter for partial text mismatches | |
projectId.not.endsWith |
query | string | No | Project - Filter for entries not ending with the text | |
rules.field |
query | string | No | Field - Filter for full text matches | |
rules.field.anyOf |
query | array | No | Field - Filter for entries where at least one reference matches the query | |
rules.field.beginsWith |
query | string | No | Field - Filter for entries starting with the text | |
rules.field.contains |
query | string | No | Field - Filter for partial text matches | |
rules.field.endsWith |
query | string | No | Field - Filter for entries ending with the text | |
rules.field.not |
query | string | No | Field - Filter for full text mismatches | |
rules.field.not.anyOf |
query | array | No | Field - Filter for entries where at least one reference mismatches the query | |
rules.field.not.beginsWith |
query | string | No | Field - Filter for entries not starting with the text | |
rules.field.not.contains |
query | string | No | Field - Filter for partial text mismatches | |
rules.field.not.endsWith |
query | string | No | Field - Filter for entries not ending with the text | |
rules.resource |
query | None | No | Resource - Filter for single value choice | |
rules.resource.anyOf |
query | array | No | Resource - ('Filter for excluding a subset of value choices',) | |
rules.resource.not |
query | None | No | Resource - ('Filter for all but a single value choice',) | |
rules.transform |
query | string | No | Transform - Filter for full text matches | |
rules.transform.anyOf |
query | array | No | Transform - Filter for entries where at least one reference matches the query | |
rules.transform.beginsWith |
query | string | No | Transform - Filter for entries starting with the text | |
rules.transform.contains |
query | string | No | Transform - Filter for partial text matches | |
rules.transform.endsWith |
query | string | No | Transform - Filter for entries ending with the text | |
rules.transform.exists |
query | boolean | No | Transform - Filter for entries with a value | |
rules.transform.not |
query | string | No | Transform - Filter for full text mismatches | |
rules.transform.not.anyOf |
query | array | No | Transform - Filter for entries where at least one reference mismatches the query | |
rules.transform.not.beginsWith |
query | string | No | Transform - Filter for entries not starting with the text | |
rules.transform.not.contains |
query | string | No | Transform - Filter for partial text mismatches | |
rules.transform.not.endsWith |
query | string | No | Transform - Filter for entries not ending with the text | |
rules.transform.not.exists |
query | boolean | No | Transform - Filter for entries without a value | |
summary |
query | string | No | Dataset summary - Filter for full text matches | |
summary.anyOf |
query | array | No | Dataset summary - Filter for entries where at least one reference matches the query | |
summary.beginsWith |
query | string | No | Dataset summary - Filter for entries starting with the text | |
summary.contains |
query | string | No | Dataset summary - Filter for partial text matches | |
summary.endsWith |
query | string | No | Dataset summary - Filter for entries ending with the text | |
summary.exists |
query | boolean | No | Dataset summary - Filter for entries with a value | |
summary.not |
query | string | No | Dataset summary - Filter for full text mismatches | |
summary.not.anyOf |
query | array | No | Dataset summary - Filter for entries where at least one reference mismatches the query | |
summary.not.beginsWith |
query | string | No | Dataset summary - Filter for entries not starting with the text | |
summary.not.contains |
query | string | No | Dataset summary - Filter for partial text mismatches | |
summary.not.endsWith |
query | string | No | Dataset summary - Filter for entries not ending with the text | |
summary.not.exists |
query | boolean | No | Dataset summary - Filter for entries without a value | |
totalExports.between |
query | array | No | Total Exports - Filter for entries with values between two specified values (inclusive) | |
totalExports.equal |
query | integer | No | Total Exports - Filter for entries with values exactly equal to the specified value | |
totalExports.greaterThan |
query | integer | No | Total Exports - Filter for entries with values greater than the specified value | |
totalExports.greaterThanOrEqual |
query | integer | No | Total Exports - Filter for entries with values greater than or equal to the specified value | |
totalExports.lessThan |
query | integer | No | Total Exports - Filter for entries with values less than the specified value | |
totalExports.lessThanOrEqual |
query | integer | No | Total Exports - Filter for entries with values less than or equal to the specified value | |
totalExports.not.between |
query | array | No | Total Exports - Filter for entries with values between two specified values (inclusive) | |
totalExports.not.equal |
query | integer | No | Total Exports - Filter for entries with values not equal to the specified value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Response 200 OK
{
"count": 0,
"items": [
{
"rules": [
{
"resource": "PatientCase",
"field": "string",
"transform": null
}
],
"lastExport": "2022-04-13T15:42:05.901Z",
"totalExports": 0,
"cohortsIds": [
"string"
],
"id": "5dd2e3b1-61d0-4fb7-aef5-24af848f0858",
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"summary": "string",
"projectId": "4b8912ce-9d81-41ab-94d3-81a0b28e1e4b",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
]
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/v1/datasets¶
Create Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"rules": [
{
"resource": "PatientCase",
"field": "string",
"transform": null
}
],
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"summary": "string",
"projectId": "3cedaa9e-de7a-4fe8-915e-7b5a730a9394"
}
Schema of the request body
{
"description": "Schema for creating a new dataset, including its composition rules.",
"properties": {
"rules": {
"default": [],
"description": "List of composition rules that define the dataset's structure.",
"items": {
"$ref": "#/components/schemas/DatasetRule"
},
"title": "Rules",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"name": {
"description": "Name of the dataset",
"maxLength": 255,
"title": "Dataset name",
"type": "string",
"x-expanded": false
},
"summary": {
"description": "Summary of the dataset",
"title": "Dataset summary",
"type": "string",
"x-expanded": false
},
"projectId": {
"description": "Project that the dataset is part of",
"format": "uuid",
"title": "Project",
"type": "string",
"x-expanded": false
}
},
"required": [
"name",
"projectId"
],
"title": "DatasetCreate",
"type": "object"
}
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/datasets/{datasetId}¶
Get Dataset By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No |
Response 200 OK
{
"rules": [
{
"resource": "PatientCase",
"field": "string",
"transform": null
}
],
"lastExport": "2022-04-13T15:42:05.901Z",
"totalExports": 0,
"cohortsIds": [
"string"
],
"id": "435341fc-edb6-4056-8b7c-efb1d4fb1655",
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"summary": "string",
"projectId": "e4b655e3-5aeb-484c-bb4f-dbab94bc1459",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
]
}
Schema of the response body
{
"description": "Schema for retrieving a dataset definition, including its composition rules.",
"properties": {
"rules": {
"default": [],
"description": "List of composition rules that define the dataset's structure.",
"items": {
"$ref": "#/components/schemas/DatasetRule"
},
"title": "Rules",
"type": "array"
},
"lastExport": {
"description": "The datetime of the last export of this dataset",
"format": "date-time",
"title": "Last Export",
"type": "string"
},
"totalExports": {
"default": 0,
"description": "The total number times this dataset has been exported",
"title": "Total Exports",
"type": "integer"
},
"cohortsIds": {
"default": [],
"description": "List of cohort IDs that have been exported with this dataset",
"items": {
"type": "string"
},
"title": "Cohorts",
"type": "array"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string",
"x-expanded": false
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"name": {
"description": "Name of the dataset",
"maxLength": 255,
"title": "Dataset name",
"type": "string",
"x-expanded": false
},
"summary": {
"description": "Summary of the dataset",
"title": "Dataset summary",
"type": "string",
"x-expanded": false
},
"projectId": {
"description": "Project that the dataset is part of",
"format": "uuid",
"title": "Project",
"type": "string",
"x-expanded": false
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
}
},
"required": [
"id",
"name",
"projectId",
"description"
],
"title": "Dataset",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/v1/datasets/{datasetId}¶
Delete Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/datasets/{datasetId}¶
Update Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No |
Request body
{
"rules": [
{
"resource": "PatientCase",
"field": "string",
"transform": null
}
],
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"summary": "string",
"projectId": "1d7df5a7-bddf-4f70-b4fe-a230a5b07297"
}
Schema of the request body
{
"description": "Schema for creating a new dataset, including its composition rules.",
"properties": {
"rules": {
"default": [],
"description": "List of composition rules that define the dataset's structure.",
"items": {
"$ref": "#/components/schemas/DatasetRule"
},
"title": "Rules",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string",
"x-expanded": false
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string",
"x-expanded": false
},
"name": {
"description": "Name of the dataset",
"maxLength": 255,
"title": "Dataset name",
"type": "string",
"x-expanded": false
},
"summary": {
"description": "Summary of the dataset",
"title": "Dataset summary",
"type": "string",
"x-expanded": false
},
"projectId": {
"description": "Project that the dataset is part of",
"format": "uuid",
"title": "Project",
"type": "string",
"x-expanded": false
}
},
"required": [
"name",
"projectId"
],
"title": "DatasetCreate",
"type": "object"
}
Response 200 OK
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/datasets/{datasetId}/history/events¶
Get All Dataset History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | None | No |
Response 200 OK
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/v1/datasets/{datasetId}/history/events/{eventId}¶
Get Dataset History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No | ||
eventId |
path | string | No |
Response 200 OK
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/v1/datasets/{datasetId}/history/events/{eventId}/reversion¶
Revert Dataset To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No | ||
eventId |
path | string | No |
Response 201 Created
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Response 404 Not Found
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Schemas¶
AccessRoles¶
Type: string
AdverseEvent¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
dateResolved |
string(date) |
description |
string |
event |
CodedConcept |
externalSource |
string |
externalSourceId |
string |
grade |
integer |
id |
string(uuid) |
mitigations |
Array<AdverseEventMitigation> |
outcome |
AdverseEventOutcomeChoices |
suspectedCauses |
Array<AdverseEventSuspectedCause> |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
AdverseEventCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
dateResolved |
string(date) |
event |
CodedConcept |
externalSource |
string |
externalSourceId |
string |
grade |
integer |
outcome |
AdverseEventOutcomeChoices |
AdverseEventFilters¶
| Name | Type |
|---|---|
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
dateResolved.after |
string(date) |
dateResolved.before |
string(date) |
dateResolved.between |
Array<> |
dateResolved.exists |
boolean |
dateResolved.not.between |
Array<> |
dateResolved.not.exists |
boolean |
dateResolved.not.on |
string(date) |
dateResolved.on |
string(date) |
dateResolved.onOrAfter |
string(date) |
dateResolved.onOrBefore |
string(date) |
event |
string |
event.anyOf |
Array<string> |
event.descendantsOf |
string |
event.not |
string |
event.not.anyOf |
Array<string> |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
grade.between |
Array<> |
grade.equal |
integer |
grade.greaterThan |
integer |
grade.greaterThanOrEqual |
integer |
grade.lessThan |
integer |
grade.lessThanOrEqual |
integer |
grade.not.between |
Array<> |
grade.not.equal |
integer |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
mitigations.adjustment |
string |
mitigations.adjustment.anyOf |
Array<string> |
mitigations.adjustment.descendantsOf |
string |
mitigations.adjustment.exists |
boolean |
mitigations.adjustment.not |
string |
mitigations.adjustment.not.anyOf |
Array<string> |
mitigations.adjustment.not.exists |
boolean |
mitigations.category |
|
mitigations.category.anyOf |
Array<string> |
mitigations.category.not |
|
mitigations.createdAt.after |
string(date) |
mitigations.createdAt.before |
string(date) |
mitigations.createdAt.between |
Array<> |
mitigations.createdAt.exists |
boolean |
mitigations.createdAt.not.between |
Array<> |
mitigations.createdAt.not.exists |
boolean |
mitigations.createdAt.not.on |
string(date) |
mitigations.createdAt.on |
string(date) |
mitigations.createdAt.onOrAfter |
string(date) |
mitigations.createdAt.onOrBefore |
string(date) |
mitigations.drug |
string |
mitigations.drug.anyOf |
Array<string> |
mitigations.drug.descendantsOf |
string |
mitigations.drug.exists |
boolean |
mitigations.drug.not |
string |
mitigations.drug.not.anyOf |
Array<string> |
mitigations.drug.not.exists |
boolean |
mitigations.externalSource |
string |
mitigations.externalSource.anyOf |
Array<string> |
mitigations.externalSource.beginsWith |
string |
mitigations.externalSource.contains |
string |
mitigations.externalSource.endsWith |
string |
mitigations.externalSource.exists |
boolean |
mitigations.externalSource.not |
string |
mitigations.externalSource.not.anyOf |
Array<string> |
mitigations.externalSource.not.beginsWith |
string |
mitigations.externalSource.not.contains |
string |
mitigations.externalSource.not.endsWith |
string |
mitigations.externalSource.not.exists |
boolean |
mitigations.id |
string |
mitigations.id.anyOf |
Array<string> |
mitigations.id.beginsWith |
string |
mitigations.id.contains |
string |
mitigations.id.endsWith |
string |
mitigations.id.not |
string |
mitigations.id.not.anyOf |
Array<string> |
mitigations.id.not.beginsWith |
string |
mitigations.id.not.contains |
string |
mitigations.id.not.endsWith |
string |
mitigations.management |
string |
mitigations.management.anyOf |
Array<string> |
mitigations.management.descendantsOf |
string |
mitigations.management.exists |
boolean |
mitigations.management.not |
string |
mitigations.management.not.anyOf |
Array<string> |
mitigations.management.not.exists |
boolean |
mitigations.procedure |
string |
mitigations.procedure.anyOf |
Array<string> |
mitigations.procedure.descendantsOf |
string |
mitigations.procedure.exists |
boolean |
mitigations.procedure.not |
string |
mitigations.procedure.not.anyOf |
Array<string> |
mitigations.procedure.not.exists |
boolean |
mitigations.updatedAt.after |
string(date) |
mitigations.updatedAt.before |
string(date) |
mitigations.updatedAt.between |
Array<> |
mitigations.updatedAt.exists |
boolean |
mitigations.updatedAt.not.between |
Array<> |
mitigations.updatedAt.not.exists |
boolean |
mitigations.updatedAt.not.on |
string(date) |
mitigations.updatedAt.on |
string(date) |
mitigations.updatedAt.onOrAfter |
string(date) |
mitigations.updatedAt.onOrBefore |
string(date) |
outcome |
|
outcome.anyOf |
Array<string> |
outcome.not |
|
suspectedCauses.causality |
|
suspectedCauses.causality.anyOf |
Array<string> |
suspectedCauses.causality.exists |
boolean |
suspectedCauses.causality.not |
|
suspectedCauses.causality.not.exists |
boolean |
suspectedCauses.createdAt.after |
string(date) |
suspectedCauses.createdAt.before |
string(date) |
suspectedCauses.createdAt.between |
Array<> |
suspectedCauses.createdAt.exists |
boolean |
suspectedCauses.createdAt.not.between |
Array<> |
suspectedCauses.createdAt.not.exists |
boolean |
suspectedCauses.createdAt.not.on |
string(date) |
suspectedCauses.createdAt.on |
string(date) |
suspectedCauses.createdAt.onOrAfter |
string(date) |
suspectedCauses.createdAt.onOrBefore |
string(date) |
suspectedCauses.externalSource |
string |
suspectedCauses.externalSource.anyOf |
Array<string> |
suspectedCauses.externalSource.beginsWith |
string |
suspectedCauses.externalSource.contains |
string |
suspectedCauses.externalSource.endsWith |
string |
suspectedCauses.externalSource.exists |
boolean |
suspectedCauses.externalSource.not |
string |
suspectedCauses.externalSource.not.anyOf |
Array<string> |
suspectedCauses.externalSource.not.beginsWith |
string |
suspectedCauses.externalSource.not.contains |
string |
suspectedCauses.externalSource.not.endsWith |
string |
suspectedCauses.externalSource.not.exists |
boolean |
suspectedCauses.id |
string |
suspectedCauses.id.anyOf |
Array<string> |
suspectedCauses.id.beginsWith |
string |
suspectedCauses.id.contains |
string |
suspectedCauses.id.endsWith |
string |
suspectedCauses.id.not |
string |
suspectedCauses.id.not.anyOf |
Array<string> |
suspectedCauses.id.not.beginsWith |
string |
suspectedCauses.id.not.contains |
string |
suspectedCauses.id.not.endsWith |
string |
suspectedCauses.medicationId |
string |
suspectedCauses.medicationId.anyOf |
Array<string> |
suspectedCauses.medicationId.beginsWith |
string |
suspectedCauses.medicationId.contains |
string |
suspectedCauses.medicationId.endsWith |
string |
suspectedCauses.medicationId.exists |
boolean |
suspectedCauses.medicationId.not |
string |
suspectedCauses.medicationId.not.anyOf |
Array<string> |
suspectedCauses.medicationId.not.beginsWith |
string |
suspectedCauses.medicationId.not.contains |
string |
suspectedCauses.medicationId.not.endsWith |
string |
suspectedCauses.medicationId.not.exists |
boolean |
suspectedCauses.radiotherapyId |
string |
suspectedCauses.radiotherapyId.anyOf |
Array<string> |
suspectedCauses.radiotherapyId.beginsWith |
string |
suspectedCauses.radiotherapyId.contains |
string |
suspectedCauses.radiotherapyId.endsWith |
string |
suspectedCauses.radiotherapyId.exists |
boolean |
suspectedCauses.radiotherapyId.not |
string |
suspectedCauses.radiotherapyId.not.anyOf |
Array<string> |
suspectedCauses.radiotherapyId.not.beginsWith |
string |
suspectedCauses.radiotherapyId.not.contains |
string |
suspectedCauses.radiotherapyId.not.endsWith |
string |
suspectedCauses.radiotherapyId.not.exists |
boolean |
suspectedCauses.surgeryId |
string |
suspectedCauses.surgeryId.anyOf |
Array<string> |
suspectedCauses.surgeryId.beginsWith |
string |
suspectedCauses.surgeryId.contains |
string |
suspectedCauses.surgeryId.endsWith |
string |
suspectedCauses.surgeryId.exists |
boolean |
suspectedCauses.surgeryId.not |
string |
suspectedCauses.surgeryId.not.anyOf |
Array<string> |
suspectedCauses.surgeryId.not.beginsWith |
string |
suspectedCauses.surgeryId.not.contains |
string |
suspectedCauses.surgeryId.not.endsWith |
string |
suspectedCauses.surgeryId.not.exists |
boolean |
suspectedCauses.systemicTherapyId |
string |
suspectedCauses.systemicTherapyId.anyOf |
Array<string> |
suspectedCauses.systemicTherapyId.beginsWith |
string |
suspectedCauses.systemicTherapyId.contains |
string |
suspectedCauses.systemicTherapyId.endsWith |
string |
suspectedCauses.systemicTherapyId.exists |
boolean |
suspectedCauses.systemicTherapyId.not |
string |
suspectedCauses.systemicTherapyId.not.anyOf |
Array<string> |
suspectedCauses.systemicTherapyId.not.beginsWith |
string |
suspectedCauses.systemicTherapyId.not.contains |
string |
suspectedCauses.systemicTherapyId.not.endsWith |
string |
suspectedCauses.systemicTherapyId.not.exists |
boolean |
suspectedCauses.updatedAt.after |
string(date) |
suspectedCauses.updatedAt.before |
string(date) |
suspectedCauses.updatedAt.between |
Array<> |
suspectedCauses.updatedAt.exists |
boolean |
suspectedCauses.updatedAt.not.between |
Array<> |
suspectedCauses.updatedAt.not.exists |
boolean |
suspectedCauses.updatedAt.not.on |
string(date) |
suspectedCauses.updatedAt.on |
string(date) |
suspectedCauses.updatedAt.onOrAfter |
string(date) |
suspectedCauses.updatedAt.onOrBefore |
string(date) |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
AdverseEventMitigation¶
| Name | Type |
|---|---|
adjustment |
|
category |
AdverseEventMitigationCategoryChoices |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
drug |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
management |
|
procedure |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
AdverseEventMitigationCategoryChoices¶
Type: string
AdverseEventMitigationCreate¶
| Name | Type |
|---|---|
adjustment |
|
category |
AdverseEventMitigationCategoryChoices |
drug |
|
externalSource |
string |
externalSourceId |
string |
management |
|
procedure |
AdverseEventMitigationPartial¶
| Name | Type |
|---|---|
adjustment |
|
category |
|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
drug |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
management |
|
procedure |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
AdverseEventOutcomeChoices¶
Type: string
AdverseEventPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
dateResolved |
string(date) |
description |
string |
event |
|
externalSource |
string |
externalSourceId |
string |
grade |
integer |
id |
string(uuid) |
mitigations |
Array<AdverseEventMitigationPartial> |
outcome |
|
suspectedCauses |
Array<AdverseEventSuspectedCausePartial> |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
AdverseEventSuspectedCause¶
| Name | Type |
|---|---|
causality |
|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
medicationId |
string(uuid) |
radiotherapyId |
string(uuid) |
surgeryId |
string(uuid) |
systemicTherapyId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
AdverseEventSuspectedCauseCausalityChoices¶
Type: string
AdverseEventSuspectedCauseCreate¶
| Name | Type |
|---|---|
causality |
|
externalSource |
string |
externalSourceId |
string |
medicationId |
string(uuid) |
radiotherapyId |
string(uuid) |
surgeryId |
string(uuid) |
systemicTherapyId |
string(uuid) |
AdverseEventSuspectedCausePartial¶
| Name | Type |
|---|---|
causality |
|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
medicationId |
string(uuid) |
radiotherapyId |
string(uuid) |
surgeryId |
string(uuid) |
systemicTherapyId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
AgeBin¶
Type: string
AnalysisMetadata¶
| Name | Type |
|---|---|
analyzedAt |
string(date-time) |
cohortId |
string |
cohortPopulation |
integer |
AnalyteDetails¶
| Name | Type |
|---|---|
acronym |
string |
display |
string |
valueTypes |
Array<AnalyteResultType> |
AnalyteResultType¶
Type: string
AneuploidScore¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
integer |
AneuploidScoreCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
category |
string |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
value |
integer |
AneuploidScorePartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
integer |
AnyGenomicSignature¶
Type:
AnyStaging¶
Type:
AnyTumorBoard¶
Type:
AuthenticationMeta¶
| Name | Type |
|---|---|
accessToken |
string |
isAuthenticated |
boolean |
sessionToken |
string |
BinetStaging¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
BinetStagingCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
BinetStagingPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
BreslowDepth¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
depth |
Measure |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
isUlcered |
boolean |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
BreslowDepthCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
depth |
Measure |
externalSource |
string |
externalSourceId |
string |
isUlcered |
boolean |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
BreslowDepthPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
depth |
|
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
isUlcered |
boolean |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
CategorizedSurvivals¶
| Name | Type |
|---|---|
metadata |
|
survivals |
ClarkStaging¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
ClarkStagingCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
ClarkStagingPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
CodedConcept¶
| Name | Type |
|---|---|
code |
string |
display |
string |
properties |
|
synonyms |
Array<string> |
system |
string |
version |
string |
Cohort¶
| Name | Type |
|---|---|
casesIds |
Array<string(uuid)> |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
excludeCriteria |
|
externalSource |
string |
externalSourceId |
string |
frozenSetIds |
Array<string(uuid)> |
id |
string(uuid) |
includeCriteria |
|
manualChoicesIds |
Array<string(uuid)> |
name |
string |
population |
integer |
projectId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
CohortContribution¶
| Name | Type |
|---|---|
contributions |
integer |
contributor |
string |
CohortCreate¶
| Name | Type |
|---|---|
casesIds |
Array<string(uuid)> |
excludeCriteria |
|
externalSource |
string |
externalSourceId |
string |
frozenSetIds |
Array<string(uuid)> |
includeCriteria |
|
manualChoicesIds |
Array<string(uuid)> |
name |
string |
projectId |
string(uuid) |
CohortFilters¶
| Name | Type |
|---|---|
casesIds |
string |
casesIds.anyOf |
Array<string> |
casesIds.beginsWith |
string |
casesIds.contains |
string |
casesIds.endsWith |
string |
casesIds.not |
string |
casesIds.not.anyOf |
Array<string> |
casesIds.not.beginsWith |
string |
casesIds.not.contains |
string |
casesIds.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
createdBy |
string |
excludeCriteria.exists |
boolean |
excludeCriteria.not.exists |
boolean |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
frozenSetIds |
string |
frozenSetIds.anyOf |
Array<string> |
frozenSetIds.beginsWith |
string |
frozenSetIds.contains |
string |
frozenSetIds.endsWith |
string |
frozenSetIds.not |
string |
frozenSetIds.not.anyOf |
Array<string> |
frozenSetIds.not.beginsWith |
string |
frozenSetIds.not.contains |
string |
frozenSetIds.not.endsWith |
string |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
includeCriteria.exists |
boolean |
includeCriteria.not.exists |
boolean |
manualChoicesIds |
string |
manualChoicesIds.anyOf |
Array<string> |
manualChoicesIds.beginsWith |
string |
manualChoicesIds.contains |
string |
manualChoicesIds.endsWith |
string |
manualChoicesIds.not |
string |
manualChoicesIds.not.anyOf |
Array<string> |
manualChoicesIds.not.beginsWith |
string |
manualChoicesIds.not.contains |
string |
manualChoicesIds.not.endsWith |
string |
name |
string |
name.anyOf |
Array<string> |
name.beginsWith |
string |
name.contains |
string |
name.endsWith |
string |
name.not |
string |
name.not.anyOf |
Array<string> |
name.not.beginsWith |
string |
name.not.contains |
string |
name.not.endsWith |
string |
population.between |
Array<> |
population.equal |
integer |
population.greaterThan |
integer |
population.greaterThanOrEqual |
integer |
population.lessThan |
integer |
population.lessThanOrEqual |
integer |
population.not.between |
Array<> |
population.not.equal |
integer |
projectId |
string |
projectId.anyOf |
Array<string> |
projectId.beginsWith |
string |
projectId.contains |
string |
projectId.endsWith |
string |
projectId.exists |
boolean |
projectId.not |
string |
projectId.not.anyOf |
Array<string> |
projectId.not.beginsWith |
string |
projectId.not.contains |
string |
projectId.not.endsWith |
string |
projectId.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
CohortQueryEntity¶
Type: string
CohortQueryFilter¶
Type: string
CohortRule¶
| Name | Type |
|---|---|
entity |
CohortQueryEntity |
filters |
Array<CohortRuleFilter> |
CohortRuleFilter¶
| Name | Type |
|---|---|
field |
string |
operator |
CohortQueryFilter |
value |
CohortRuleset¶
| Name | Type |
|---|---|
condition |
|
rules |
Array<> |
CohortTraitCounts¶
| Name | Type |
|---|---|
category |
string |
counts |
integer |
percentage |
number |
CohortTraitMedian¶
| Name | Type |
|---|---|
interQuartalRange |
|
median |
CohortTraits¶
| Name | Type |
|---|---|
age |
CohortTraitMedian |
consentStatus |
Array<CohortTraitCounts> |
dataCompletion |
CohortTraitMedian |
genders |
Array<CohortTraitCounts> |
neoplasticSites |
Array<CohortTraitCounts> |
overallSurvival |
CohortTraitMedian |
therapyLines |
Array<CohortTraitCounts> |
ComorbiditiesAssessment¶
| Name | Type |
|---|---|
absentConditions |
Array<CodedConcept> |
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
indexConditionId |
string(uuid) |
panel |
|
presentConditions |
Array<CodedConcept> |
score |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
ComorbiditiesAssessmentCreate¶
| Name | Type |
|---|---|
absentConditions |
Array<CodedConcept> |
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
indexConditionId |
string(uuid) |
panel |
|
presentConditions |
Array<CodedConcept> |
ComorbiditiesAssessmentFilters¶
| Name | Type |
|---|---|
absentConditions |
string |
absentConditions.allOf |
Array<string> |
absentConditions.anyOf |
Array<string> |
absentConditions.descendantsOf |
string |
absentConditions.exists |
boolean |
absentConditions.not |
string |
absentConditions.not.allOf |
Array<string> |
absentConditions.not.anyOf |
Array<string> |
absentConditions.not.exists |
boolean |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
indexConditionId |
string |
indexConditionId.anyOf |
Array<string> |
indexConditionId.beginsWith |
string |
indexConditionId.contains |
string |
indexConditionId.endsWith |
string |
indexConditionId.not |
string |
indexConditionId.not.anyOf |
Array<string> |
indexConditionId.not.beginsWith |
string |
indexConditionId.not.contains |
string |
indexConditionId.not.endsWith |
string |
panel |
|
panel.anyOf |
Array<string> |
panel.exists |
boolean |
panel.not |
|
panel.not.exists |
boolean |
presentConditions |
string |
presentConditions.allOf |
Array<string> |
presentConditions.anyOf |
Array<string> |
presentConditions.descendantsOf |
string |
presentConditions.exists |
boolean |
presentConditions.not |
string |
presentConditions.not.allOf |
Array<string> |
presentConditions.not.anyOf |
Array<string> |
presentConditions.not.exists |
boolean |
score.between |
Array<> |
score.equal |
integer |
score.exists |
boolean |
score.greaterThan |
integer |
score.greaterThanOrEqual |
integer |
score.lessThan |
integer |
score.lessThanOrEqual |
integer |
score.not.between |
Array<> |
score.not.equal |
integer |
score.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
ComorbiditiesAssessmentPanelChoices¶
Type: string
ComorbiditiesAssessmentPartial¶
| Name | Type |
|---|---|
absentConditions |
|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
indexConditionId |
string(uuid) |
panel |
|
presentConditions |
|
score |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
ComorbiditiesPanel¶
| Name | Type |
|---|---|
categories |
Array<ComorbidityPanelCategory> |
name |
string |
ComorbidityPanelCategory¶
| Name | Type |
|---|---|
conditions |
Array<CodedConcept> |
default |
|
label |
string |
ConflictResolution¶
Type: string
CountsPerMonth¶
| Name | Type |
|---|---|
cumulativeCount |
integer |
month |
string(date) |
DataCompletionStatistics¶
| Name | Type |
|---|---|
completionOverTime |
Array<CountsPerMonth> |
mostIncompleteCategories |
Array<IncompleteCategory> |
overallCompletion |
number |
totalCases |
integer |
DataPlatformStatistics¶
| Name | Type |
|---|---|
cases |
integer |
clinicalCenters |
integer |
cohorts |
integer |
contributors |
integer |
entries |
integer |
mutations |
integer |
primarySites |
integer |
projects |
integer |
DataResource¶
Type: string
Dataset¶
| Name | Type |
|---|---|
cohortsIds |
Array<string> |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
lastExport |
string(date-time) |
name |
string |
projectId |
string(uuid) |
rules |
Array<DatasetRule> |
summary |
string |
totalExports |
integer |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
DatasetCreate¶
| Name | Type |
|---|---|
externalSource |
string |
externalSourceId |
string |
name |
string |
projectId |
string(uuid) |
rules |
Array<DatasetRule> |
summary |
string |
DatasetFilters¶
| Name | Type |
|---|---|
cohortsIds |
string |
cohortsIds.anyOf |
Array<string> |
cohortsIds.beginsWith |
string |
cohortsIds.contains |
string |
cohortsIds.endsWith |
string |
cohortsIds.not |
string |
cohortsIds.not.anyOf |
Array<string> |
cohortsIds.not.beginsWith |
string |
cohortsIds.not.contains |
string |
cohortsIds.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
createdBy |
string |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
lastExport.after |
string(date) |
lastExport.before |
string(date) |
lastExport.between |
Array<> |
lastExport.exists |
boolean |
lastExport.not.between |
Array<> |
lastExport.not.exists |
boolean |
lastExport.not.on |
string(date) |
lastExport.on |
string(date) |
lastExport.onOrAfter |
string(date) |
lastExport.onOrBefore |
string(date) |
name |
string |
name.anyOf |
Array<string> |
name.beginsWith |
string |
name.contains |
string |
name.endsWith |
string |
name.not |
string |
name.not.anyOf |
Array<string> |
name.not.beginsWith |
string |
name.not.contains |
string |
name.not.endsWith |
string |
projectId |
string |
projectId.anyOf |
Array<string> |
projectId.beginsWith |
string |
projectId.contains |
string |
projectId.endsWith |
string |
projectId.not |
string |
projectId.not.anyOf |
Array<string> |
projectId.not.beginsWith |
string |
projectId.not.contains |
string |
projectId.not.endsWith |
string |
rules.field |
string |
rules.field.anyOf |
Array<string> |
rules.field.beginsWith |
string |
rules.field.contains |
string |
rules.field.endsWith |
string |
rules.field.not |
string |
rules.field.not.anyOf |
Array<string> |
rules.field.not.beginsWith |
string |
rules.field.not.contains |
string |
rules.field.not.endsWith |
string |
rules.resource |
|
rules.resource.anyOf |
Array<string> |
rules.resource.not |
|
rules.transform |
string |
rules.transform.anyOf |
Array<string> |
rules.transform.beginsWith |
string |
rules.transform.contains |
string |
rules.transform.endsWith |
string |
rules.transform.exists |
boolean |
rules.transform.not |
string |
rules.transform.not.anyOf |
Array<string> |
rules.transform.not.beginsWith |
string |
rules.transform.not.contains |
string |
rules.transform.not.endsWith |
string |
rules.transform.not.exists |
boolean |
summary |
string |
summary.anyOf |
Array<string> |
summary.beginsWith |
string |
summary.contains |
string |
summary.endsWith |
string |
summary.exists |
boolean |
summary.not |
string |
summary.not.anyOf |
Array<string> |
summary.not.beginsWith |
string |
summary.not.contains |
string |
summary.not.endsWith |
string |
summary.not.exists |
boolean |
totalExports.between |
Array<> |
totalExports.equal |
integer |
totalExports.greaterThan |
integer |
totalExports.greaterThanOrEqual |
integer |
totalExports.lessThan |
integer |
totalExports.lessThanOrEqual |
integer |
totalExports.not.between |
Array<> |
totalExports.not.equal |
integer |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
DatasetRule¶
| Name | Type |
|---|---|
field |
string |
resource |
DataResource |
transform |
Distribution¶
| Name | Type |
|---|---|
items |
Array<CohortTraitCounts> |
metadata |
DNAChangeType¶
Type: string
EntityStatistics¶
| Name | Type |
|---|---|
dataCompletionMedian |
number |
population |
integer |
topographyCode |
string |
topographyGroup |
string |
ExportedCohortDefinition¶
| Name | Type |
|---|---|
checksum |
string |
definition |
CohortCreate |
exportedAt |
string(date-time) |
exportedBy |
string |
exportVersion |
string |
ExportedPatientCaseDataset¶
| Name | Type |
|---|---|
checksum |
string |
dataset |
Array<PatientCaseDataset> |
exportedAt |
string(date-time) |
exportedBy |
string |
exportVersion |
string |
FamilyHistory¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
contributedToDeath |
boolean |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
hadCancer |
boolean |
id |
string(uuid) |
morphology |
|
onsetAge |
integer |
relationship |
CodedConcept |
topography |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
FamilyHistoryCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
contributedToDeath |
boolean |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
hadCancer |
boolean |
morphology |
|
onsetAge |
integer |
relationship |
CodedConcept |
topography |
FamilyHistoryFilters¶
| Name | Type |
|---|---|
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
contributedToDeath |
boolean |
contributedToDeath.exists |
boolean |
contributedToDeath.not.exists |
boolean |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
hadCancer |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
morphology |
string |
morphology.anyOf |
Array<string> |
morphology.descendantsOf |
string |
morphology.exists |
boolean |
morphology.not |
string |
morphology.not.anyOf |
Array<string> |
morphology.not.exists |
boolean |
onsetAge.between |
Array<> |
onsetAge.equal |
integer |
onsetAge.exists |
boolean |
onsetAge.greaterThan |
integer |
onsetAge.greaterThanOrEqual |
integer |
onsetAge.lessThan |
integer |
onsetAge.lessThanOrEqual |
integer |
onsetAge.not.between |
Array<> |
onsetAge.not.equal |
integer |
onsetAge.not.exists |
boolean |
relationship |
string |
relationship.anyOf |
Array<string> |
relationship.descendantsOf |
string |
relationship.not |
string |
relationship.not.anyOf |
Array<string> |
topography |
string |
topography.anyOf |
Array<string> |
topography.descendantsOf |
string |
topography.exists |
boolean |
topography.not |
string |
topography.not.anyOf |
Array<string> |
topography.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
FamilyHistoryPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
contributedToDeath |
boolean |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
hadCancer |
boolean |
id |
string(uuid) |
morphology |
|
onsetAge |
integer |
relationship |
|
topography |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
FIGOStaging¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
|
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
FIGOStagingCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
methodology |
|
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
GenomicSignatureFilters¶
| Name | Type |
|---|---|
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
category |
|
category.anyOf |
Array<string> |
category.not |
|
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
GenomicSignatureTypes¶
Type: string
GenomicVariant¶
| Name | Type |
|---|---|
alleleDepth |
integer |
alleleFrequency |
number |
analysisMethod |
|
anonymized |
boolean |
assessment |
|
assessmentDate |
string(date) |
caseId |
string(uuid) |
clinicalRelevance |
|
clinvar |
string |
confidence |
|
coordinateSystem |
|
copyNumber |
integer |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
dnaChangePosition |
integer |
dnaChangePositionRange |
|
dnaChangeType |
|
dnaHgvs |
string |
dnaReferenceSequence |
string |
externalSource |
string |
externalSourceId |
string |
genePanel |
string |
genes |
Array<CodedConcept> |
genomeAssemblyVersion |
|
id |
string(uuid) |
inheritance |
|
isPathogenic |
boolean |
isVUS |
boolean |
molecularConsequence |
|
nucleotidesLength |
integer |
proteinChangeType |
|
proteinHgvs |
string |
proteinReferenceSequence |
string |
regions |
Array<string> |
rnaChangePosition |
string |
rnaChangeType |
|
rnaHgvs |
string |
rnaReferenceSequence |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
zygosity |
GenomicVariantAssessmentChoices¶
Type: string
GenomicVariantClinicalRelevanceChoices¶
Type: string
GenomicVariantConfidenceChoices¶
Type: string
GenomicVariantCreate¶
| Name | Type |
|---|---|
alleleDepth |
integer |
alleleFrequency |
number |
analysisMethod |
|
assessment |
|
assessmentDate |
string(date) |
caseId |
string(uuid) |
clinicalRelevance |
|
clinvar |
string |
confidence |
|
coordinateSystem |
|
copyNumber |
integer |
date |
string(date) |
dnaHgvs |
string |
externalSource |
string |
externalSourceId |
string |
genePanel |
string |
genes |
Array<CodedConcept> |
genomeAssemblyVersion |
|
inheritance |
|
molecularConsequence |
|
proteinHgvs |
string |
rnaHgvs |
string |
zygosity |
GenomicVariantFilters¶
| Name | Type |
|---|---|
alleleDepth.between |
Array<> |
alleleDepth.equal |
integer |
alleleDepth.exists |
boolean |
alleleDepth.greaterThan |
integer |
alleleDepth.greaterThanOrEqual |
integer |
alleleDepth.lessThan |
integer |
alleleDepth.lessThanOrEqual |
integer |
alleleDepth.not.between |
Array<> |
alleleDepth.not.equal |
integer |
alleleDepth.not.exists |
boolean |
alleleFrequency.between |
Array<> |
alleleFrequency.equal |
number |
alleleFrequency.exists |
boolean |
alleleFrequency.greaterThan |
number |
alleleFrequency.greaterThanOrEqual |
number |
alleleFrequency.lessThan |
number |
alleleFrequency.lessThanOrEqual |
number |
alleleFrequency.not.between |
Array<> |
alleleFrequency.not.equal |
number |
alleleFrequency.not.exists |
boolean |
analysisMethod |
string |
analysisMethod.anyOf |
Array<string> |
analysisMethod.descendantsOf |
string |
analysisMethod.exists |
boolean |
analysisMethod.not |
string |
analysisMethod.not.anyOf |
Array<string> |
analysisMethod.not.exists |
boolean |
assessment |
|
assessment.anyOf |
Array<string> |
assessment.exists |
boolean |
assessment.not |
|
assessment.not.exists |
boolean |
assessmentDate.after |
string(date) |
assessmentDate.before |
string(date) |
assessmentDate.between |
Array<> |
assessmentDate.exists |
boolean |
assessmentDate.not.between |
Array<> |
assessmentDate.not.exists |
boolean |
assessmentDate.not.on |
string(date) |
assessmentDate.on |
string(date) |
assessmentDate.onOrAfter |
string(date) |
assessmentDate.onOrBefore |
string(date) |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
clinicalRelevance |
|
clinicalRelevance.anyOf |
Array<string> |
clinicalRelevance.exists |
boolean |
clinicalRelevance.not |
|
clinicalRelevance.not.exists |
boolean |
clinvar |
string |
clinvar.anyOf |
Array<string> |
clinvar.beginsWith |
string |
clinvar.contains |
string |
clinvar.endsWith |
string |
clinvar.exists |
boolean |
clinvar.not |
string |
clinvar.not.anyOf |
Array<string> |
clinvar.not.beginsWith |
string |
clinvar.not.contains |
string |
clinvar.not.endsWith |
string |
clinvar.not.exists |
boolean |
confidence |
|
confidence.anyOf |
Array<string> |
confidence.exists |
boolean |
confidence.not |
|
confidence.not.exists |
boolean |
coordinateSystem |
string |
coordinateSystem.anyOf |
Array<string> |
coordinateSystem.descendantsOf |
string |
coordinateSystem.exists |
boolean |
coordinateSystem.not |
string |
coordinateSystem.not.anyOf |
Array<string> |
coordinateSystem.not.exists |
boolean |
copyNumber.between |
Array<> |
copyNumber.equal |
integer |
copyNumber.exists |
boolean |
copyNumber.greaterThan |
integer |
copyNumber.greaterThanOrEqual |
integer |
copyNumber.lessThan |
integer |
copyNumber.lessThanOrEqual |
integer |
copyNumber.not.between |
Array<> |
copyNumber.not.equal |
integer |
copyNumber.not.exists |
boolean |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
dnaChangePosition.between |
Array<> |
dnaChangePosition.equal |
integer |
dnaChangePosition.exists |
boolean |
dnaChangePosition.greaterThan |
integer |
dnaChangePosition.greaterThanOrEqual |
integer |
dnaChangePosition.lessThan |
integer |
dnaChangePosition.lessThanOrEqual |
integer |
dnaChangePosition.not.between |
Array<> |
dnaChangePosition.not.equal |
integer |
dnaChangePosition.not.exists |
boolean |
dnaChangePositionRange.containedBy |
Array<> |
dnaChangePositionRange.contains |
Array<> |
dnaChangePositionRange.exists |
boolean |
dnaChangePositionRange.not.containedBy |
Array<> |
dnaChangePositionRange.not.contains |
Array<> |
dnaChangePositionRange.not.exists |
boolean |
dnaChangePositionRange.not.overlaps |
Array<> |
dnaChangePositionRange.overlaps |
Array<> |
dnaChangeType |
|
dnaChangeType.anyOf |
Array<string> |
dnaChangeType.exists |
boolean |
dnaChangeType.not |
|
dnaChangeType.not.exists |
boolean |
dnaHgvs |
string |
dnaHgvs.anyOf |
Array<string> |
dnaHgvs.beginsWith |
string |
dnaHgvs.contains |
string |
dnaHgvs.endsWith |
string |
dnaHgvs.exists |
boolean |
dnaHgvs.not |
string |
dnaHgvs.not.anyOf |
Array<string> |
dnaHgvs.not.beginsWith |
string |
dnaHgvs.not.contains |
string |
dnaHgvs.not.endsWith |
string |
dnaHgvs.not.exists |
boolean |
dnaReferenceSequence |
string |
dnaReferenceSequence.anyOf |
Array<string> |
dnaReferenceSequence.beginsWith |
string |
dnaReferenceSequence.contains |
string |
dnaReferenceSequence.endsWith |
string |
dnaReferenceSequence.exists |
boolean |
dnaReferenceSequence.not |
string |
dnaReferenceSequence.not.anyOf |
Array<string> |
dnaReferenceSequence.not.beginsWith |
string |
dnaReferenceSequence.not.contains |
string |
dnaReferenceSequence.not.endsWith |
string |
dnaReferenceSequence.not.exists |
boolean |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
genePanel |
string |
genePanel.anyOf |
Array<string> |
genePanel.beginsWith |
string |
genePanel.contains |
string |
genePanel.endsWith |
string |
genePanel.exists |
boolean |
genePanel.not |
string |
genePanel.not.anyOf |
Array<string> |
genePanel.not.beginsWith |
string |
genePanel.not.contains |
string |
genePanel.not.endsWith |
string |
genePanel.not.exists |
boolean |
genes |
string |
genes.allOf |
Array<string> |
genes.anyOf |
Array<string> |
genes.descendantsOf |
string |
genes.not |
string |
genes.not.allOf |
Array<string> |
genes.not.anyOf |
Array<string> |
genomeAssemblyVersion |
string |
genomeAssemblyVersion.anyOf |
Array<string> |
genomeAssemblyVersion.descendantsOf |
string |
genomeAssemblyVersion.exists |
boolean |
genomeAssemblyVersion.not |
string |
genomeAssemblyVersion.not.anyOf |
Array<string> |
genomeAssemblyVersion.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
inheritance |
string |
inheritance.anyOf |
Array<string> |
inheritance.descendantsOf |
string |
inheritance.exists |
boolean |
inheritance.not |
string |
inheritance.not.anyOf |
Array<string> |
inheritance.not.exists |
boolean |
isPathogenic |
boolean |
isPathogenic.exists |
boolean |
isPathogenic.not.exists |
boolean |
isVUS |
boolean |
isVUS.exists |
boolean |
isVUS.not.exists |
boolean |
molecularConsequence |
string |
molecularConsequence.anyOf |
Array<string> |
molecularConsequence.descendantsOf |
string |
molecularConsequence.exists |
boolean |
molecularConsequence.not |
string |
molecularConsequence.not.anyOf |
Array<string> |
molecularConsequence.not.exists |
boolean |
nucleotidesLength.between |
Array<> |
nucleotidesLength.equal |
integer |
nucleotidesLength.exists |
boolean |
nucleotidesLength.greaterThan |
integer |
nucleotidesLength.greaterThanOrEqual |
integer |
nucleotidesLength.lessThan |
integer |
nucleotidesLength.lessThanOrEqual |
integer |
nucleotidesLength.not.between |
Array<> |
nucleotidesLength.not.equal |
integer |
nucleotidesLength.not.exists |
boolean |
proteinChangeType |
|
proteinChangeType.anyOf |
Array<string> |
proteinChangeType.exists |
boolean |
proteinChangeType.not |
|
proteinChangeType.not.exists |
boolean |
proteinHgvs |
string |
proteinHgvs.anyOf |
Array<string> |
proteinHgvs.beginsWith |
string |
proteinHgvs.contains |
string |
proteinHgvs.endsWith |
string |
proteinHgvs.exists |
boolean |
proteinHgvs.not |
string |
proteinHgvs.not.anyOf |
Array<string> |
proteinHgvs.not.beginsWith |
string |
proteinHgvs.not.contains |
string |
proteinHgvs.not.endsWith |
string |
proteinHgvs.not.exists |
boolean |
proteinReferenceSequence |
string |
proteinReferenceSequence.anyOf |
Array<string> |
proteinReferenceSequence.beginsWith |
string |
proteinReferenceSequence.contains |
string |
proteinReferenceSequence.endsWith |
string |
proteinReferenceSequence.exists |
boolean |
proteinReferenceSequence.not |
string |
proteinReferenceSequence.not.anyOf |
Array<string> |
proteinReferenceSequence.not.beginsWith |
string |
proteinReferenceSequence.not.contains |
string |
proteinReferenceSequence.not.endsWith |
string |
proteinReferenceSequence.not.exists |
boolean |
regions |
string |
regions.anyOf |
Array<string> |
regions.beginsWith |
string |
regions.contains |
string |
regions.endsWith |
string |
regions.exists |
boolean |
regions.not |
string |
regions.not.anyOf |
Array<string> |
regions.not.beginsWith |
string |
regions.not.contains |
string |
regions.not.endsWith |
string |
regions.not.exists |
boolean |
rnaChangePosition |
string |
rnaChangePosition.anyOf |
Array<string> |
rnaChangePosition.beginsWith |
string |
rnaChangePosition.contains |
string |
rnaChangePosition.endsWith |
string |
rnaChangePosition.exists |
boolean |
rnaChangePosition.not |
string |
rnaChangePosition.not.anyOf |
Array<string> |
rnaChangePosition.not.beginsWith |
string |
rnaChangePosition.not.contains |
string |
rnaChangePosition.not.endsWith |
string |
rnaChangePosition.not.exists |
boolean |
rnaChangeType |
|
rnaChangeType.anyOf |
Array<string> |
rnaChangeType.exists |
boolean |
rnaChangeType.not |
|
rnaChangeType.not.exists |
boolean |
rnaHgvs |
string |
rnaHgvs.anyOf |
Array<string> |
rnaHgvs.beginsWith |
string |
rnaHgvs.contains |
string |
rnaHgvs.endsWith |
string |
rnaHgvs.exists |
boolean |
rnaHgvs.not |
string |
rnaHgvs.not.anyOf |
Array<string> |
rnaHgvs.not.beginsWith |
string |
rnaHgvs.not.contains |
string |
rnaHgvs.not.endsWith |
string |
rnaHgvs.not.exists |
boolean |
rnaReferenceSequence |
string |
rnaReferenceSequence.anyOf |
Array<string> |
rnaReferenceSequence.beginsWith |
string |
rnaReferenceSequence.contains |
string |
rnaReferenceSequence.endsWith |
string |
rnaReferenceSequence.exists |
boolean |
rnaReferenceSequence.not |
string |
rnaReferenceSequence.not.anyOf |
Array<string> |
rnaReferenceSequence.not.beginsWith |
string |
rnaReferenceSequence.not.contains |
string |
rnaReferenceSequence.not.endsWith |
string |
rnaReferenceSequence.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
zygosity |
string |
zygosity.anyOf |
Array<string> |
zygosity.descendantsOf |
string |
zygosity.exists |
boolean |
zygosity.not |
string |
zygosity.not.anyOf |
Array<string> |
zygosity.not.exists |
boolean |
GenomicVariantPartial¶
| Name | Type |
|---|---|
alleleDepth |
integer |
alleleFrequency |
number |
analysisMethod |
|
anonymized |
boolean |
assessment |
|
assessmentDate |
string(date) |
caseId |
string(uuid) |
clinicalRelevance |
|
clinvar |
string |
confidence |
|
coordinateSystem |
|
copyNumber |
integer |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
dnaChangePosition |
integer |
dnaChangePositionRange |
|
dnaChangeType |
|
dnaHgvs |
string |
dnaReferenceSequence |
string |
externalSource |
string |
externalSourceId |
string |
genePanel |
string |
genes |
|
genomeAssemblyVersion |
|
id |
string(uuid) |
inheritance |
|
isPathogenic |
boolean |
isVUS |
boolean |
molecularConsequence |
|
nucleotidesLength |
integer |
proteinChangeType |
|
proteinHgvs |
string |
proteinReferenceSequence |
string |
regions |
Array<string> |
rnaChangePosition |
string |
rnaChangeType |
|
rnaHgvs |
string |
rnaReferenceSequence |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
zygosity |
GleasonGrade¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
GleasonGradeCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
GleasonGradePartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
HealthCheck¶
| Name | Type |
|---|---|
database |
|
database_connection_time_ms |
|
migrations |
|
server |
string |
HistoryEvent¶
| Name | Type |
|---|---|
category |
HistoryEventCategory |
context |
|
differential |
|
id |
|
resource |
string |
resourceId |
|
snapshot |
|
timestamp |
string(date-time) |
url |
string |
user |
string |
HistoryEventCategory¶
Type: string
HistoryEventWithSchema¶
| Name | Type |
|---|---|
category |
HistoryEventCategory |
context |
|
differential |
|
id |
|
resource |
string |
resourceId |
|
snapshot |
|
timestamp |
string(date-time) |
url |
string |
user |
string |
HomologousRecombinationDeficiency¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
interpretation |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
number |
HomologousRecombinationDeficiencyCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
category |
string |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
interpretation |
|
value |
number |
HomologousRecombinationDeficiencyInterpretationChoices¶
Type: string
HomologousRecombinationDeficiencyPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
interpretation |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
number |
IncompleteCategory¶
| Name | Type |
|---|---|
affectedSites |
Array<CodedConcept> |
cases |
integer |
category |
string |
Input¶
| Name | Type |
|---|---|
limit |
integer |
offset |
integer |
INRGSSStage¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
INRGSSStageCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
INRGSSStagePartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
INSSStage¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
INSSStageCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
INSSStagePartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
ISSStaging¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
ISSStagingCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
ISSStagingPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
KaplanMeierCurve¶
| Name | Type |
|---|---|
lowerConfidenceBand |
Array<number> |
metadata |
|
months |
Array<number> |
probabilities |
Array<number> |
upperConfidenceBand |
Array<number> |
Lifestyle¶
| Name | Type |
|---|---|
alcoholConsumption |
|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
exposures |
Array<CodedConcept> |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
nightSleep |
|
recreationalDrugs |
Array<CodedConcept> |
smokingPackyears |
number |
smokingQuited |
|
smokingStatus |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
LifestyleCreate¶
| Name | Type |
|---|---|
alcoholConsumption |
|
caseId |
string(uuid) |
date |
string(date) |
exposures |
Array<CodedConcept> |
externalSource |
string |
externalSourceId |
string |
nightSleep |
|
recreationalDrugs |
Array<CodedConcept> |
smokingPackyears |
number |
smokingQuited |
|
smokingStatus |
LifestyleFilters¶
| Name | Type |
|---|---|
alcoholConsumption |
string |
alcoholConsumption.anyOf |
Array<string> |
alcoholConsumption.descendantsOf |
string |
alcoholConsumption.exists |
boolean |
alcoholConsumption.not |
string |
alcoholConsumption.not.anyOf |
Array<string> |
alcoholConsumption.not.exists |
boolean |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
exposures |
string |
exposures.allOf |
Array<string> |
exposures.anyOf |
Array<string> |
exposures.descendantsOf |
string |
exposures.exists |
boolean |
exposures.not |
string |
exposures.not.allOf |
Array<string> |
exposures.not.anyOf |
Array<string> |
exposures.not.exists |
boolean |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
nightSleep.between |
Array<> |
nightSleep.equal |
number |
nightSleep.exists |
boolean |
nightSleep.greaterThan |
number |
nightSleep.greaterThanOrEqual |
number |
nightSleep.lessThan |
number |
nightSleep.lessThanOrEqual |
number |
nightSleep.not.between |
Array<> |
nightSleep.not.equal |
number |
nightSleep.not.exists |
boolean |
recreationalDrugs |
string |
recreationalDrugs.allOf |
Array<string> |
recreationalDrugs.anyOf |
Array<string> |
recreationalDrugs.descendantsOf |
string |
recreationalDrugs.exists |
boolean |
recreationalDrugs.not |
string |
recreationalDrugs.not.allOf |
Array<string> |
recreationalDrugs.not.anyOf |
Array<string> |
recreationalDrugs.not.exists |
boolean |
smokingPackyears.between |
Array<> |
smokingPackyears.equal |
number |
smokingPackyears.exists |
boolean |
smokingPackyears.greaterThan |
number |
smokingPackyears.greaterThanOrEqual |
number |
smokingPackyears.lessThan |
number |
smokingPackyears.lessThanOrEqual |
number |
smokingPackyears.not.between |
Array<> |
smokingPackyears.not.equal |
number |
smokingPackyears.not.exists |
boolean |
smokingQuited.between |
Array<> |
smokingQuited.equal |
number |
smokingQuited.exists |
boolean |
smokingQuited.greaterThan |
number |
smokingQuited.greaterThanOrEqual |
number |
smokingQuited.lessThan |
number |
smokingQuited.lessThanOrEqual |
number |
smokingQuited.not.between |
Array<> |
smokingQuited.not.equal |
number |
smokingQuited.not.exists |
boolean |
smokingStatus |
string |
smokingStatus.anyOf |
Array<string> |
smokingStatus.descendantsOf |
string |
smokingStatus.exists |
boolean |
smokingStatus.not |
string |
smokingStatus.not.anyOf |
Array<string> |
smokingStatus.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
LifestylePartial¶
| Name | Type |
|---|---|
alcoholConsumption |
|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
exposures |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
nightSleep |
|
recreationalDrugs |
|
smokingPackyears |
number |
smokingQuited |
|
smokingStatus |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
LossOfHeterozygosity¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
number |
LossOfHeterozygosityCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
category |
string |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
value |
number |
LossOfHeterozygosityPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
number |
LymphomaStaging¶
| Name | Type |
|---|---|
anonymized |
boolean |
bulky |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
|
modifiers |
Array<CodedConcept> |
pathological |
boolean |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
LymphomaStagingCreate¶
| Name | Type |
|---|---|
bulky |
boolean |
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
methodology |
|
modifiers |
Array<CodedConcept> |
pathological |
boolean |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
LymphomaStagingPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
bulky |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
|
modifiers |
|
pathological |
boolean |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
Measure¶
| Name | Type |
|---|---|
unit |
string |
value |
number |
MeasureConversion¶
| Name | Type |
|---|---|
newUnit |
string |
unit |
string |
value |
number |
MicrosatelliteInstability¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
CodedConcept |
MicrosatelliteInstabilityCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
category |
string |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
value |
CodedConcept |
MicrosatelliteInstabilityPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
ModifiedResource¶
| Name | Type |
|---|---|
description |
string |
id |
string(uuid) |
MolecularTherapeuticRecommendation¶
| Name | Type |
|---|---|
clinicalTrial |
string |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
drugs |
Array<CodedConcept> |
expectedEffect |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
offLabelUse |
boolean |
supportingGenomicSignaturesIds |
Array<string(uuid)> |
supportingGenomicVariantsIds |
Array<string(uuid)> |
supportingTumorMarkersIds |
Array<string(uuid)> |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
withinSoc |
boolean |
MolecularTherapeuticRecommendationCreate¶
| Name | Type |
|---|---|
clinicalTrial |
string |
drugs |
Array<CodedConcept> |
expectedEffect |
|
externalSource |
string |
externalSourceId |
string |
offLabelUse |
boolean |
supportingGenomicSignaturesIds |
Array<string(uuid)> |
supportingGenomicVariantsIds |
Array<string(uuid)> |
supportingTumorMarkersIds |
Array<string(uuid)> |
withinSoc |
boolean |
MolecularTumorBoard¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
characterizedCup |
boolean |
conductedCupCharacterization |
boolean |
conductedMolecularComparison |
boolean |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
molecularComparisonMatchId |
string(uuid) |
recommendations |
Array<CodedConcept> |
relatedEntitiesIds |
Array<string(uuid)> |
reviewedReports |
Array<string> |
therapeuticRecommendations |
Array<MolecularTherapeuticRecommendation> |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
MolecularTumorBoardCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
category |
string |
characterizedCup |
boolean |
conductedCupCharacterization |
boolean |
conductedMolecularComparison |
boolean |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
molecularComparisonMatchId |
string(uuid) |
recommendations |
Array<CodedConcept> |
relatedEntitiesIds |
Array<string(uuid)> |
reviewedReports |
Array<string> |
NeoplasticEntity¶
| Name | Type |
|---|---|
anonymized |
boolean |
assertionDate |
string(date) |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
differentitation |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
laterality |
|
morphology |
CodedConcept |
relatedPrimaryId |
string(uuid) |
relationship |
NeoplasticEntityRelationshipChoices |
topography |
CodedConcept |
topographyGroup |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
NeoplasticEntityCreate¶
| Name | Type |
|---|---|
assertionDate |
string(date) |
caseId |
string(uuid) |
differentitation |
|
externalSource |
string |
externalSourceId |
string |
laterality |
|
morphology |
CodedConcept |
relatedPrimaryId |
string(uuid) |
relationship |
NeoplasticEntityRelationshipChoices |
topography |
CodedConcept |
NeoplasticEntityFilters¶
| Name | Type |
|---|---|
assertionDate.after |
string(date) |
assertionDate.before |
string(date) |
assertionDate.between |
Array<> |
assertionDate.not.between |
Array<> |
assertionDate.not.on |
string(date) |
assertionDate.on |
string(date) |
assertionDate.onOrAfter |
string(date) |
assertionDate.onOrBefore |
string(date) |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
differentitation |
string |
differentitation.anyOf |
Array<string> |
differentitation.descendantsOf |
string |
differentitation.exists |
boolean |
differentitation.not |
string |
differentitation.not.anyOf |
Array<string> |
differentitation.not.exists |
boolean |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
laterality |
string |
laterality.anyOf |
Array<string> |
laterality.descendantsOf |
string |
laterality.exists |
boolean |
laterality.not |
string |
laterality.not.anyOf |
Array<string> |
laterality.not.exists |
boolean |
morphology |
string |
morphology.anyOf |
Array<string> |
morphology.descendantsOf |
string |
morphology.not |
string |
morphology.not.anyOf |
Array<string> |
relatedPrimaryId |
string |
relatedPrimaryId.anyOf |
Array<string> |
relatedPrimaryId.beginsWith |
string |
relatedPrimaryId.contains |
string |
relatedPrimaryId.endsWith |
string |
relatedPrimaryId.exists |
boolean |
relatedPrimaryId.not |
string |
relatedPrimaryId.not.anyOf |
Array<string> |
relatedPrimaryId.not.beginsWith |
string |
relatedPrimaryId.not.contains |
string |
relatedPrimaryId.not.endsWith |
string |
relatedPrimaryId.not.exists |
boolean |
relationship |
|
relationship.anyOf |
Array<string> |
relationship.not |
|
topography |
string |
topography.anyOf |
Array<string> |
topography.descendantsOf |
string |
topography.not |
string |
topography.not.anyOf |
Array<string> |
topographyGroup |
string |
topographyGroup.anyOf |
Array<string> |
topographyGroup.descendantsOf |
string |
topographyGroup.exists |
boolean |
topographyGroup.not |
string |
topographyGroup.not.anyOf |
Array<string> |
topographyGroup.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
NeoplasticEntityPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
assertionDate |
string(date) |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
differentitation |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
laterality |
|
morphology |
|
relatedPrimaryId |
string(uuid) |
relationship |
|
topography |
|
topographyGroup |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
NeoplasticEntityRelationshipChoices¶
Type: string
ninja__pagination__LimitOffsetPagination__Input¶
| Name | Type |
|---|---|
limit |
integer |
offset |
integer |
ninja_extra__ordering__Ordering__Input¶
| Name | Type |
|---|---|
ordering |
onconova__core__anonymization__decorator__AnonymizationBase__Input¶
| Name | Type |
|---|---|
anonymized |
boolean |
OncoplotDataset¶
| Name | Type |
|---|---|
cases |
Array<string> |
genes |
Array<string> |
metadata |
|
variants |
Array<OncoplotVariant> |
OncoplotVariant¶
| Name | Type |
|---|---|
caseId |
string |
gene |
string |
hgvsExpression |
string |
isPathogenic |
boolean |
Paginated_AdverseEvent_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<AdverseEvent> |
Paginated_AnyGenomicSignature_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<AnyGenomicSignature> |
Paginated_AnyStaging_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<AnyStaging> |
Paginated_AnyTumorBoard_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<AnyTumorBoard> |
Paginated_CodedConcept_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<CodedConcept> |
Paginated_Cohort_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<Cohort> |
Paginated_ComorbiditiesAssessment_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<ComorbiditiesAssessment> |
Paginated_Dataset_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<Dataset> |
Paginated_FamilyHistory_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<FamilyHistory> |
Paginated_GenomicVariant_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<GenomicVariant> |
Paginated_HistoryEvent_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<HistoryEvent> |
Paginated_HistoryEventWithSchema_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<HistoryEventWithSchema> |
Paginated_Lifestyle_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<Lifestyle> |
Paginated_NeoplasticEntity_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<NeoplasticEntity> |
Paginated_PatientCase_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<PatientCase> |
Paginated_PatientCaseDataset_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<PatientCaseDataset> |
Paginated_PerformanceStatus_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<PerformanceStatus> |
Paginated_Project_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<Project> |
Paginated_ProjectDataManagerGrant_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<ProjectDataManagerGrant> |
Paginated_Radiotherapy_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<Radiotherapy> |
Paginated_RiskAssessment_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<RiskAssessment> |
Paginated_Surgery_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<Surgery> |
Paginated_SystemicTherapy_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<SystemicTherapy> |
Paginated_TherapyLine_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<TherapyLine> |
Paginated_TreatmentResponse_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<TreatmentResponse> |
Paginated_TumorMarker_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<TumorMarker> |
Paginated_User_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<User> |
Paginated_Vitals_¶
| Name | Type |
|---|---|
count |
integer |
items |
Array<Vitals> |
PatientCase¶
| Name | Type |
|---|---|
age |
|
ageAtDiagnosis |
|
anonymized |
boolean |
causeOfDeath |
|
clinicalCenter |
string |
clinicalIdentifier |
string |
consentStatus |
|
contributors |
Array<string> |
createdAt |
string(date-time) |
createdBy |
string |
dataCompletionRate |
number |
dateOfBirth |
|
dateOfDeath |
string(date) |
description |
string |
endOfRecords |
string(date) |
externalSource |
string |
externalSourceId |
string |
gender |
CodedConcept |
genderIdentity |
|
id |
string(uuid) |
overallSurvival |
number |
pseudoidentifier |
string |
race |
|
sexAtBirth |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
vitalStatus |
PatientCaseBundle¶
| Name | Type |
|---|---|
adverseEvents |
Array<AdverseEvent> |
age |
|
ageAtDiagnosis |
|
anonymized |
boolean |
causeOfDeath |
|
clinicalCenter |
string |
clinicalIdentifier |
string |
comorbidities |
Array<ComorbiditiesAssessment> |
completedDataCategories |
|
consentStatus |
|
contributors |
Array<string> |
createdAt |
string(date-time) |
createdBy |
string |
dataCompletionRate |
number |
dateOfBirth |
|
dateOfDeath |
string(date) |
description |
string |
endOfRecords |
string(date) |
externalSource |
string |
externalSourceId |
string |
familyHistory |
Array<FamilyHistory> |
gender |
CodedConcept |
genderIdentity |
|
genomicSignatures |
Array<> |
genomicVariants |
Array<GenomicVariant> |
history |
Array<HistoryEvent> |
id |
string(uuid) |
lifestyles |
Array<Lifestyle> |
neoplasticEntities |
Array<NeoplasticEntity> |
overallSurvival |
number |
performanceStatus |
Array<PerformanceStatus> |
pseudoidentifier |
string |
race |
|
radiotherapies |
Array<Radiotherapy> |
riskAssessments |
Array<RiskAssessment> |
sexAtBirth |
|
stagings |
Array<> |
surgeries |
Array<Surgery> |
systemicTherapies |
Array<SystemicTherapy> |
therapyLines |
Array<TherapyLine> |
treatmentResponses |
Array<TreatmentResponse> |
tumorBoards |
Array<> |
tumorMarkers |
Array<TumorMarker> |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
vitals |
Array<Vitals> |
vitalStatus |
PatientCaseConsentStatusChoices¶
Type: string
PatientCaseCreate¶
| Name | Type |
|---|---|
causeOfDeath |
|
clinicalCenter |
string |
clinicalIdentifier |
string |
consentStatus |
|
dateOfBirth |
string(date) |
dateOfDeath |
string(date) |
endOfRecords |
string(date) |
externalSource |
string |
externalSourceId |
string |
gender |
CodedConcept |
genderIdentity |
|
race |
|
sexAtBirth |
|
vitalStatus |
PatientCaseDataCategories¶
Type: string
PatientCaseDataCompletionStatusSchema¶
| Name | Type |
|---|---|
status |
boolean |
timestamp |
string(date-time) |
username |
string |
PatientCaseDataset¶
| Name | Type |
|---|---|
adverseEvents |
Array<AdverseEventPartial> |
age |
|
ageAtDiagnosis |
|
aneuploidScores |
Array<AneuploidScorePartial> |
anonymized |
boolean |
binetStagings |
Array<BinetStagingPartial> |
breslowStagings |
Array<BreslowDepthPartial> |
causeOfDeath |
|
clarkStagings |
Array<ClarkStagingPartial> |
clinicalCenter |
string |
clinicalIdentifier |
string |
comorbidities |
Array<ComorbiditiesAssessmentPartial> |
consentStatus |
|
contributors |
Array<string> |
createdAt |
string(date-time) |
createdBy |
string |
dataCompletionRate |
number |
dateOfBirth |
|
dateOfDeath |
string(date) |
description |
string |
endOfRecords |
string(date) |
externalSource |
string |
externalSourceId |
string |
familyHistory |
Array<FamilyHistoryPartial> |
figoStagings |
Array<TNMStagingPartial> |
gender |
|
genderIdentity |
|
genomicVariants |
Array<GenomicVariantPartial> |
gleasonStagings |
Array<GleasonGradePartial> |
homologousRecombinationDeficiencies |
Array<HomologousRecombinationDeficiencyPartial> |
id |
string(uuid) |
inrgssStagings |
Array<INRGSSStagePartial> |
inssStagings |
Array<INSSStagePartial> |
issStagings |
Array<ISSStagingPartial> |
lifestyles |
Array<LifestylePartial> |
lossesOfHeterozygosity |
Array<LossOfHeterozygosityPartial> |
lymphomaStagings |
Array<LymphomaStagingPartial> |
microsatelliteInstabilities |
Array<MicrosatelliteInstabilityPartial> |
molecularTumorBoards |
Array<UnspecifiedTumorBoardPartial> |
neoplasticEntities |
Array<NeoplasticEntityPartial> |
overallSurvival |
number |
performanceStatus |
Array<PerformanceStatusPartial> |
pseudoidentifier |
string |
race |
|
radiotherapies |
Array<RadiotherapyPartial> |
raiStagings |
Array<RaiStagingPartial> |
rhabdomyosarcomaGroups |
Array<RhabdomyosarcomaClinicalGroupPartial> |
riskAssessments |
Array<RiskAssessmentPartial> |
rissStagings |
Array<RISSStagingPartial> |
sexAtBirth |
|
surgeries |
Array<SurgeryPartial> |
systemicTherapies |
Array<SystemicTherapyPartial> |
therapyLines |
Array<TherapyLinePartial> |
tnmStagings |
Array<TNMStagingPartial> |
treatmentResponses |
Array<TreatmentResponsePartial> |
tumorMarkers |
Array<TumorMarkerPartial> |
tumorMutationalBurdens |
Array<TumorMutationalBurdenPartial> |
tumorNeoantigenBurdens |
Array<TumorNeoantigenBurdenPartial> |
unspecifiedTumorBoards |
Array<UnspecifiedTumorBoardPartial> |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
vitals |
Array<VitalsPartial> |
vitalStatus |
|
wilmsStagings |
Array<WilmsStagePartial> |
PatientCaseFilters¶
| Name | Type |
|---|---|
age.between |
Array<> |
age.equal |
integer |
age.greaterThan |
integer |
age.greaterThanOrEqual |
integer |
age.lessThan |
integer |
age.lessThanOrEqual |
integer |
age.not.between |
Array<> |
age.not.equal |
integer |
ageAtDiagnosis.between |
Array<> |
ageAtDiagnosis.equal |
integer |
ageAtDiagnosis.exists |
boolean |
ageAtDiagnosis.greaterThan |
integer |
ageAtDiagnosis.greaterThanOrEqual |
integer |
ageAtDiagnosis.lessThan |
integer |
ageAtDiagnosis.lessThanOrEqual |
integer |
ageAtDiagnosis.not.between |
Array<> |
ageAtDiagnosis.not.equal |
integer |
ageAtDiagnosis.not.exists |
boolean |
causeOfDeath |
string |
causeOfDeath.anyOf |
Array<string> |
causeOfDeath.descendantsOf |
string |
causeOfDeath.exists |
boolean |
causeOfDeath.not |
string |
causeOfDeath.not.anyOf |
Array<string> |
causeOfDeath.not.exists |
boolean |
consentStatus |
|
consentStatus.anyOf |
Array<string> |
consentStatus.not |
|
contributors |
Array<string> |
contributors.containedBy |
Array<string> |
contributors.contains |
Array<string> |
contributors.not |
Array<string> |
contributors.not.containedBy |
Array<string> |
contributors.not.contains |
Array<string> |
contributors.not.overlaps |
Array<string> |
contributors.overlaps |
Array<string> |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
dataCompletionRate.between |
Array<> |
dataCompletionRate.equal |
number |
dataCompletionRate.greaterThan |
number |
dataCompletionRate.greaterThanOrEqual |
number |
dataCompletionRate.lessThan |
number |
dataCompletionRate.lessThanOrEqual |
number |
dataCompletionRate.not.between |
Array<> |
dataCompletionRate.not.equal |
number |
endOfRecords.after |
string(date) |
endOfRecords.before |
string(date) |
endOfRecords.between |
Array<> |
endOfRecords.exists |
boolean |
endOfRecords.not.between |
Array<> |
endOfRecords.not.exists |
boolean |
endOfRecords.not.on |
string(date) |
endOfRecords.on |
string(date) |
endOfRecords.onOrAfter |
string(date) |
endOfRecords.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
gender |
string |
gender.anyOf |
Array<string> |
gender.descendantsOf |
string |
gender.not |
string |
gender.not.anyOf |
Array<string> |
genderIdentity |
string |
genderIdentity.anyOf |
Array<string> |
genderIdentity.descendantsOf |
string |
genderIdentity.exists |
boolean |
genderIdentity.not |
string |
genderIdentity.not.anyOf |
Array<string> |
genderIdentity.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
morphology |
string |
overallSurvival.between |
Array<> |
overallSurvival.equal |
number |
overallSurvival.exists |
boolean |
overallSurvival.greaterThan |
number |
overallSurvival.greaterThanOrEqual |
number |
overallSurvival.lessThan |
number |
overallSurvival.lessThanOrEqual |
number |
overallSurvival.not.between |
Array<> |
overallSurvival.not.equal |
number |
overallSurvival.not.exists |
boolean |
primarySite |
string |
pseudoidentifier |
string |
pseudoidentifier.anyOf |
Array<string> |
pseudoidentifier.beginsWith |
string |
pseudoidentifier.contains |
string |
pseudoidentifier.endsWith |
string |
pseudoidentifier.not |
string |
pseudoidentifier.not.anyOf |
Array<string> |
pseudoidentifier.not.beginsWith |
string |
pseudoidentifier.not.contains |
string |
pseudoidentifier.not.endsWith |
string |
race |
string |
race.anyOf |
Array<string> |
race.descendantsOf |
string |
race.exists |
boolean |
race.not |
string |
race.not.anyOf |
Array<string> |
race.not.exists |
boolean |
sexAtBirth |
string |
sexAtBirth.anyOf |
Array<string> |
sexAtBirth.descendantsOf |
string |
sexAtBirth.exists |
boolean |
sexAtBirth.not |
string |
sexAtBirth.not.anyOf |
Array<string> |
sexAtBirth.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
vitalStatus |
|
vitalStatus.anyOf |
Array<string> |
vitalStatus.not |
PatientCaseIdentifier¶
Type: string
PatientCaseVitalStatusChoices¶
Type: string
PerformanceStatus¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
ecogInterpretation |
|
ecogScore |
integer |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
karnofskyInterpretation |
|
karnofskyScore |
integer |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
PerformanceStatusCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
ecogScore |
integer |
externalSource |
string |
externalSourceId |
string |
karnofskyScore |
integer |
PerformanceStatusFilters¶
| Name | Type |
|---|---|
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
ecogInterpretation |
string |
ecogInterpretation.anyOf |
Array<string> |
ecogInterpretation.descendantsOf |
string |
ecogInterpretation.exists |
boolean |
ecogInterpretation.not |
string |
ecogInterpretation.not.anyOf |
Array<string> |
ecogInterpretation.not.exists |
boolean |
ecogScore.between |
Array<> |
ecogScore.equal |
integer |
ecogScore.exists |
boolean |
ecogScore.greaterThan |
integer |
ecogScore.greaterThanOrEqual |
integer |
ecogScore.lessThan |
integer |
ecogScore.lessThanOrEqual |
integer |
ecogScore.not.between |
Array<> |
ecogScore.not.equal |
integer |
ecogScore.not.exists |
boolean |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
karnofskyInterpretation |
string |
karnofskyInterpretation.anyOf |
Array<string> |
karnofskyInterpretation.descendantsOf |
string |
karnofskyInterpretation.exists |
boolean |
karnofskyInterpretation.not |
string |
karnofskyInterpretation.not.anyOf |
Array<string> |
karnofskyInterpretation.not.exists |
boolean |
karnofskyScore.between |
Array<> |
karnofskyScore.equal |
integer |
karnofskyScore.exists |
boolean |
karnofskyScore.greaterThan |
integer |
karnofskyScore.greaterThanOrEqual |
integer |
karnofskyScore.lessThan |
integer |
karnofskyScore.lessThanOrEqual |
integer |
karnofskyScore.not.between |
Array<> |
karnofskyScore.not.equal |
integer |
karnofskyScore.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
PerformanceStatusPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
ecogInterpretation |
|
ecogScore |
integer |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
karnofskyInterpretation |
|
karnofskyScore |
integer |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
Period¶
| Name | Type |
|---|---|
end |
string(date) |
start |
string(date) |
Project¶
| Name | Type |
|---|---|
clinicalCenters |
Array<string> |
createdAt |
string(date-time) |
createdBy |
string |
dataConstraints |
|
description |
string |
ethicsApprovalNumber |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
leader |
string |
members |
Array<string> |
status |
|
summary |
string |
title |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
ProjectCreate¶
| Name | Type |
|---|---|
clinicalCenters |
Array<string> |
dataConstraints |
|
ethicsApprovalNumber |
string |
externalSource |
string |
externalSourceId |
string |
leader |
string |
members |
Array<string> |
status |
|
summary |
string |
title |
string |
ProjectDataManagerGrant¶
| Name | Type |
|---|---|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
isValid |
boolean |
member |
string |
projectId |
string(uuid) |
revoked |
boolean |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
validityPeriod |
Period |
ProjectDataManagerGrantCreate¶
| Name | Type |
|---|---|
externalSource |
string |
externalSourceId |
string |
revoked |
boolean |
validityPeriod |
Period |
ProjectFilters¶
| Name | Type |
|---|---|
clinicalCenters |
string |
clinicalCenters.anyOf |
Array<string> |
clinicalCenters.beginsWith |
string |
clinicalCenters.contains |
string |
clinicalCenters.endsWith |
string |
clinicalCenters.not |
string |
clinicalCenters.not.anyOf |
Array<string> |
clinicalCenters.not.beginsWith |
string |
clinicalCenters.not.contains |
string |
clinicalCenters.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
ethicsApprovalNumber |
string |
ethicsApprovalNumber.anyOf |
Array<string> |
ethicsApprovalNumber.beginsWith |
string |
ethicsApprovalNumber.contains |
string |
ethicsApprovalNumber.endsWith |
string |
ethicsApprovalNumber.not |
string |
ethicsApprovalNumber.not.anyOf |
Array<string> |
ethicsApprovalNumber.not.beginsWith |
string |
ethicsApprovalNumber.not.contains |
string |
ethicsApprovalNumber.not.endsWith |
string |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
leader.username |
string |
leader.username.anyOf |
Array<string> |
leader.username.not |
string |
leader.username.not.anyOf |
string |
members.username |
string |
members.username.anyOf |
Array<string> |
members.username.not |
string |
members.username.not.anyOf |
string |
status |
|
status.anyOf |
Array<string> |
status.not |
|
summary |
string |
summary.anyOf |
Array<string> |
summary.beginsWith |
string |
summary.contains |
string |
summary.endsWith |
string |
summary.not |
string |
summary.not.anyOf |
Array<string> |
summary.not.beginsWith |
string |
summary.not.contains |
string |
summary.not.endsWith |
string |
title |
string |
title.anyOf |
Array<string> |
title.beginsWith |
string |
title.contains |
string |
title.endsWith |
string |
title.not |
string |
title.not.anyOf |
Array<string> |
title.not.beginsWith |
string |
title.not.contains |
string |
title.not.endsWith |
string |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
ProjectStatusChoices¶
Type: string
ProteinChangeType¶
Type: string
Radiotherapy¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
dosages |
Array<RadiotherapyDosage> |
duration |
Measure |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
intent |
RadiotherapyIntentChoices |
period |
Period |
sessions |
integer |
settings |
Array<RadiotherapySetting> |
targetedEntitiesIds |
Array<string(uuid)> |
terminationReason |
|
therapyLineId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RadiotherapyCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
externalSource |
string |
externalSourceId |
string |
intent |
RadiotherapyIntentChoices |
period |
Period |
sessions |
integer |
targetedEntitiesIds |
Array<string(uuid)> |
terminationReason |
|
therapyLineId |
string(uuid) |
RadiotherapyDosage¶
| Name | Type |
|---|---|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
dose |
|
externalSource |
string |
externalSourceId |
string |
fractions |
integer |
id |
string(uuid) |
irradiatedVolume |
CodedConcept |
irradiatedVolumeMorphology |
|
irradiatedVolumeQualifier |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RadiotherapyDosageCreate¶
| Name | Type |
|---|---|
dose |
|
externalSource |
string |
externalSourceId |
string |
fractions |
integer |
irradiatedVolume |
CodedConcept |
irradiatedVolumeMorphology |
|
irradiatedVolumeQualifier |
RadiotherapyDosagePartial¶
| Name | Type |
|---|---|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
dose |
|
externalSource |
string |
externalSourceId |
string |
fractions |
integer |
id |
string(uuid) |
irradiatedVolume |
|
irradiatedVolumeMorphology |
|
irradiatedVolumeQualifier |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RadiotherapyFilters¶
| Name | Type |
|---|---|
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
dosages.createdAt.after |
string(date) |
dosages.createdAt.before |
string(date) |
dosages.createdAt.between |
Array<> |
dosages.createdAt.exists |
boolean |
dosages.createdAt.not.between |
Array<> |
dosages.createdAt.not.exists |
boolean |
dosages.createdAt.not.on |
string(date) |
dosages.createdAt.on |
string(date) |
dosages.createdAt.onOrAfter |
string(date) |
dosages.createdAt.onOrBefore |
string(date) |
dosages.dose.between |
Array<> |
dosages.dose.equal |
number |
dosages.dose.exists |
boolean |
dosages.dose.greaterThan |
number |
dosages.dose.greaterThanOrEqual |
number |
dosages.dose.lessThan |
number |
dosages.dose.lessThanOrEqual |
number |
dosages.dose.not.between |
Array<> |
dosages.dose.not.equal |
number |
dosages.dose.not.exists |
boolean |
dosages.externalSource |
string |
dosages.externalSource.anyOf |
Array<string> |
dosages.externalSource.beginsWith |
string |
dosages.externalSource.contains |
string |
dosages.externalSource.endsWith |
string |
dosages.externalSource.exists |
boolean |
dosages.externalSource.not |
string |
dosages.externalSource.not.anyOf |
Array<string> |
dosages.externalSource.not.beginsWith |
string |
dosages.externalSource.not.contains |
string |
dosages.externalSource.not.endsWith |
string |
dosages.externalSource.not.exists |
boolean |
dosages.fractions.between |
Array<> |
dosages.fractions.equal |
integer |
dosages.fractions.exists |
boolean |
dosages.fractions.greaterThan |
integer |
dosages.fractions.greaterThanOrEqual |
integer |
dosages.fractions.lessThan |
integer |
dosages.fractions.lessThanOrEqual |
integer |
dosages.fractions.not.between |
Array<> |
dosages.fractions.not.equal |
integer |
dosages.fractions.not.exists |
boolean |
dosages.id |
string |
dosages.id.anyOf |
Array<string> |
dosages.id.beginsWith |
string |
dosages.id.contains |
string |
dosages.id.endsWith |
string |
dosages.id.not |
string |
dosages.id.not.anyOf |
Array<string> |
dosages.id.not.beginsWith |
string |
dosages.id.not.contains |
string |
dosages.id.not.endsWith |
string |
dosages.irradiatedVolume |
string |
dosages.irradiatedVolume.anyOf |
Array<string> |
dosages.irradiatedVolume.descendantsOf |
string |
dosages.irradiatedVolume.not |
string |
dosages.irradiatedVolume.not.anyOf |
Array<string> |
dosages.irradiatedVolumeMorphology |
string |
dosages.irradiatedVolumeMorphology.anyOf |
Array<string> |
dosages.irradiatedVolumeMorphology.descendantsOf |
string |
dosages.irradiatedVolumeMorphology.exists |
boolean |
dosages.irradiatedVolumeMorphology.not |
string |
dosages.irradiatedVolumeMorphology.not.anyOf |
Array<string> |
dosages.irradiatedVolumeMorphology.not.exists |
boolean |
dosages.irradiatedVolumeQualifier |
string |
dosages.irradiatedVolumeQualifier.anyOf |
Array<string> |
dosages.irradiatedVolumeQualifier.descendantsOf |
string |
dosages.irradiatedVolumeQualifier.exists |
boolean |
dosages.irradiatedVolumeQualifier.not |
string |
dosages.irradiatedVolumeQualifier.not.anyOf |
Array<string> |
dosages.irradiatedVolumeQualifier.not.exists |
boolean |
dosages.updatedAt.after |
string(date) |
dosages.updatedAt.before |
string(date) |
dosages.updatedAt.between |
Array<> |
dosages.updatedAt.exists |
boolean |
dosages.updatedAt.not.between |
Array<> |
dosages.updatedAt.not.exists |
boolean |
dosages.updatedAt.not.on |
string(date) |
dosages.updatedAt.on |
string(date) |
dosages.updatedAt.onOrAfter |
string(date) |
dosages.updatedAt.onOrBefore |
string(date) |
duration.between |
Array<> |
duration.equal |
number |
duration.greaterThan |
number |
duration.greaterThanOrEqual |
number |
duration.lessThan |
number |
duration.lessThanOrEqual |
number |
duration.not.between |
Array<> |
duration.not.equal |
number |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
intent |
|
intent.anyOf |
Array<string> |
intent.not |
|
period.containedBy |
Array<> |
period.contains |
Array<> |
period.not.containedBy |
Array<> |
period.not.contains |
Array<> |
period.not.overlaps |
Array<> |
period.overlaps |
Array<> |
sessions.between |
Array<> |
sessions.equal |
integer |
sessions.greaterThan |
integer |
sessions.greaterThanOrEqual |
integer |
sessions.lessThan |
integer |
sessions.lessThanOrEqual |
integer |
sessions.not.between |
Array<> |
sessions.not.equal |
integer |
settings.createdAt.after |
string(date) |
settings.createdAt.before |
string(date) |
settings.createdAt.between |
Array<> |
settings.createdAt.exists |
boolean |
settings.createdAt.not.between |
Array<> |
settings.createdAt.not.exists |
boolean |
settings.createdAt.not.on |
string(date) |
settings.createdAt.on |
string(date) |
settings.createdAt.onOrAfter |
string(date) |
settings.createdAt.onOrBefore |
string(date) |
settings.externalSource |
string |
settings.externalSource.anyOf |
Array<string> |
settings.externalSource.beginsWith |
string |
settings.externalSource.contains |
string |
settings.externalSource.endsWith |
string |
settings.externalSource.exists |
boolean |
settings.externalSource.not |
string |
settings.externalSource.not.anyOf |
Array<string> |
settings.externalSource.not.beginsWith |
string |
settings.externalSource.not.contains |
string |
settings.externalSource.not.endsWith |
string |
settings.externalSource.not.exists |
boolean |
settings.id |
string |
settings.id.anyOf |
Array<string> |
settings.id.beginsWith |
string |
settings.id.contains |
string |
settings.id.endsWith |
string |
settings.id.not |
string |
settings.id.not.anyOf |
Array<string> |
settings.id.not.beginsWith |
string |
settings.id.not.contains |
string |
settings.id.not.endsWith |
string |
settings.modality |
string |
settings.modality.anyOf |
Array<string> |
settings.modality.descendantsOf |
string |
settings.modality.not |
string |
settings.modality.not.anyOf |
Array<string> |
settings.technique |
string |
settings.technique.anyOf |
Array<string> |
settings.technique.descendantsOf |
string |
settings.technique.not |
string |
settings.technique.not.anyOf |
Array<string> |
settings.updatedAt.after |
string(date) |
settings.updatedAt.before |
string(date) |
settings.updatedAt.between |
Array<> |
settings.updatedAt.exists |
boolean |
settings.updatedAt.not.between |
Array<> |
settings.updatedAt.not.exists |
boolean |
settings.updatedAt.not.on |
string(date) |
settings.updatedAt.on |
string(date) |
settings.updatedAt.onOrAfter |
string(date) |
settings.updatedAt.onOrBefore |
string(date) |
targetedEntitiesIds |
string |
targetedEntitiesIds.anyOf |
Array<string> |
targetedEntitiesIds.beginsWith |
string |
targetedEntitiesIds.contains |
string |
targetedEntitiesIds.endsWith |
string |
targetedEntitiesIds.not |
string |
targetedEntitiesIds.not.anyOf |
Array<string> |
targetedEntitiesIds.not.beginsWith |
string |
targetedEntitiesIds.not.contains |
string |
targetedEntitiesIds.not.endsWith |
string |
terminationReason |
string |
terminationReason.anyOf |
Array<string> |
terminationReason.descendantsOf |
string |
terminationReason.exists |
boolean |
terminationReason.not |
string |
terminationReason.not.anyOf |
Array<string> |
terminationReason.not.exists |
boolean |
therapyLineId |
string |
therapyLineId.anyOf |
Array<string> |
therapyLineId.beginsWith |
string |
therapyLineId.contains |
string |
therapyLineId.endsWith |
string |
therapyLineId.exists |
boolean |
therapyLineId.not |
string |
therapyLineId.not.anyOf |
Array<string> |
therapyLineId.not.beginsWith |
string |
therapyLineId.not.contains |
string |
therapyLineId.not.endsWith |
string |
therapyLineId.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
RadiotherapyIntentChoices¶
Type: string
RadiotherapyPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
dosages |
Array<RadiotherapyDosagePartial> |
duration |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
intent |
|
period |
string |
sessions |
integer |
settings |
Array<RadiotherapySettingPartial> |
targetedEntitiesIds |
Array<string(uuid)> |
terminationReason |
|
therapyLineId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RadiotherapySetting¶
| Name | Type |
|---|---|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
modality |
CodedConcept |
technique |
CodedConcept |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RadiotherapySettingCreate¶
| Name | Type |
|---|---|
externalSource |
string |
externalSourceId |
string |
modality |
CodedConcept |
technique |
CodedConcept |
RadiotherapySettingPartial¶
| Name | Type |
|---|---|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
modality |
|
technique |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RaiStaging¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
|
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RaiStagingCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
methodology |
|
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
RaiStagingPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
|
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
Range¶
| Name | Type |
|---|---|
end |
|
start |
RhabdomyosarcomaClinicalGroup¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RhabdomyosarcomaClinicalGroupCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
RhabdomyosarcomaClinicalGroupPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RiskAssessment¶
| Name | Type |
|---|---|
anonymized |
boolean |
assessedEntitiesIds |
Array<string(uuid)> |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
CodedConcept |
risk |
CodedConcept |
score |
number |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RiskAssessmentCreate¶
| Name | Type |
|---|---|
assessedEntitiesIds |
Array<string(uuid)> |
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
methodology |
CodedConcept |
risk |
CodedConcept |
score |
number |
RiskAssessmentFilters¶
| Name | Type |
|---|---|
assessedEntitiesIds |
string |
assessedEntitiesIds.anyOf |
Array<string> |
assessedEntitiesIds.beginsWith |
string |
assessedEntitiesIds.contains |
string |
assessedEntitiesIds.endsWith |
string |
assessedEntitiesIds.not |
string |
assessedEntitiesIds.not.anyOf |
Array<string> |
assessedEntitiesIds.not.beginsWith |
string |
assessedEntitiesIds.not.contains |
string |
assessedEntitiesIds.not.endsWith |
string |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
methodology |
string |
methodology.anyOf |
Array<string> |
methodology.descendantsOf |
string |
methodology.not |
string |
methodology.not.anyOf |
Array<string> |
risk |
string |
risk.anyOf |
Array<string> |
risk.descendantsOf |
string |
risk.not |
string |
risk.not.anyOf |
Array<string> |
score.between |
Array<> |
score.equal |
number |
score.exists |
boolean |
score.greaterThan |
number |
score.greaterThanOrEqual |
number |
score.lessThan |
number |
score.lessThanOrEqual |
number |
score.not.between |
Array<> |
score.not.equal |
number |
score.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
RiskAssessmentPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
assessedEntitiesIds |
Array<string(uuid)> |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
|
risk |
|
score |
number |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RISSStaging¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RISSStagingCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
RISSStagingPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
RNAChangeType¶
Type: string
RulesetCondition¶
Type: string
StagingDomain¶
Type: string
StagingFilters¶
| Name | Type |
|---|---|
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
stage |
string |
stage.anyOf |
Array<string> |
stage.descendantsOf |
string |
stage.not |
string |
stage.not.anyOf |
Array<string> |
stagedEntitiesIds |
string |
stagedEntitiesIds.anyOf |
Array<string> |
stagedEntitiesIds.beginsWith |
string |
stagedEntitiesIds.contains |
string |
stagedEntitiesIds.endsWith |
string |
stagedEntitiesIds.not |
string |
stagedEntitiesIds.not.anyOf |
Array<string> |
stagedEntitiesIds.not.beginsWith |
string |
stagedEntitiesIds.not.contains |
string |
stagedEntitiesIds.not.endsWith |
string |
stagingDomain |
|
stagingDomain.anyOf |
Array<string> |
stagingDomain.not |
|
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
Surgery¶
| Name | Type |
|---|---|
anonymized |
boolean |
bodysite |
|
bodysiteLaterality |
|
bodysiteQualifier |
|
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
intent |
SurgeryIntentChoices |
outcome |
|
procedure |
CodedConcept |
targetedEntitiesIds |
Array<string(uuid)> |
therapyLineId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
SurgeryCreate¶
| Name | Type |
|---|---|
bodysite |
|
bodysiteLaterality |
|
bodysiteQualifier |
|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
intent |
SurgeryIntentChoices |
outcome |
|
procedure |
CodedConcept |
targetedEntitiesIds |
Array<string(uuid)> |
therapyLineId |
string(uuid) |
SurgeryFilters¶
| Name | Type |
|---|---|
bodysite |
string |
bodysite.anyOf |
Array<string> |
bodysite.descendantsOf |
string |
bodysite.exists |
boolean |
bodysite.not |
string |
bodysite.not.anyOf |
Array<string> |
bodysite.not.exists |
boolean |
bodysiteLaterality |
string |
bodysiteLaterality.anyOf |
Array<string> |
bodysiteLaterality.descendantsOf |
string |
bodysiteLaterality.exists |
boolean |
bodysiteLaterality.not |
string |
bodysiteLaterality.not.anyOf |
Array<string> |
bodysiteLaterality.not.exists |
boolean |
bodysiteQualifier |
string |
bodysiteQualifier.anyOf |
Array<string> |
bodysiteQualifier.descendantsOf |
string |
bodysiteQualifier.exists |
boolean |
bodysiteQualifier.not |
string |
bodysiteQualifier.not.anyOf |
Array<string> |
bodysiteQualifier.not.exists |
boolean |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
intent |
|
intent.anyOf |
Array<string> |
intent.not |
|
outcome |
string |
outcome.anyOf |
Array<string> |
outcome.descendantsOf |
string |
outcome.exists |
boolean |
outcome.not |
string |
outcome.not.anyOf |
Array<string> |
outcome.not.exists |
boolean |
procedure |
string |
procedure.anyOf |
Array<string> |
procedure.descendantsOf |
string |
procedure.not |
string |
procedure.not.anyOf |
Array<string> |
targetedEntitiesIds |
string |
targetedEntitiesIds.anyOf |
Array<string> |
targetedEntitiesIds.beginsWith |
string |
targetedEntitiesIds.contains |
string |
targetedEntitiesIds.endsWith |
string |
targetedEntitiesIds.not |
string |
targetedEntitiesIds.not.anyOf |
Array<string> |
targetedEntitiesIds.not.beginsWith |
string |
targetedEntitiesIds.not.contains |
string |
targetedEntitiesIds.not.endsWith |
string |
therapyLineId |
string |
therapyLineId.anyOf |
Array<string> |
therapyLineId.beginsWith |
string |
therapyLineId.contains |
string |
therapyLineId.endsWith |
string |
therapyLineId.exists |
boolean |
therapyLineId.not |
string |
therapyLineId.not.anyOf |
Array<string> |
therapyLineId.not.beginsWith |
string |
therapyLineId.not.contains |
string |
therapyLineId.not.endsWith |
string |
therapyLineId.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
SurgeryIntentChoices¶
Type: string
SurgeryPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
bodysite |
|
bodysiteLaterality |
|
bodysiteQualifier |
|
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
intent |
|
outcome |
|
procedure |
|
targetedEntitiesIds |
Array<string(uuid)> |
therapyLineId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
SystemicTherapy¶
| Name | Type |
|---|---|
adjunctiveRole |
|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
cycles |
integer |
description |
string |
duration |
Measure |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
intent |
SystemicTherapyIntentChoices |
isAdjunctive |
boolean |
medications |
Array<SystemicTherapyMedication> |
period |
Period |
targetedEntitiesIds |
Array<string(uuid)> |
terminationReason |
|
therapyLineId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
SystemicTherapyCreate¶
| Name | Type |
|---|---|
adjunctiveRole |
|
caseId |
string(uuid) |
cycles |
integer |
externalSource |
string |
externalSourceId |
string |
intent |
SystemicTherapyIntentChoices |
period |
Period |
targetedEntitiesIds |
Array<string(uuid)> |
terminationReason |
|
therapyLineId |
string(uuid) |
SystemicTherapyFilters¶
| Name | Type |
|---|---|
adjunctiveRole |
string |
adjunctiveRole.anyOf |
Array<string> |
adjunctiveRole.descendantsOf |
string |
adjunctiveRole.exists |
boolean |
adjunctiveRole.not |
string |
adjunctiveRole.not.anyOf |
Array<string> |
adjunctiveRole.not.exists |
boolean |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
cycles.between |
Array<> |
cycles.equal |
integer |
cycles.exists |
boolean |
cycles.greaterThan |
integer |
cycles.greaterThanOrEqual |
integer |
cycles.lessThan |
integer |
cycles.lessThanOrEqual |
integer |
cycles.not.between |
Array<> |
cycles.not.equal |
integer |
cycles.not.exists |
boolean |
duration.between |
Array<> |
duration.equal |
number |
duration.greaterThan |
number |
duration.greaterThanOrEqual |
number |
duration.lessThan |
number |
duration.lessThanOrEqual |
number |
duration.not.between |
Array<> |
duration.not.equal |
number |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
intent |
|
intent.anyOf |
Array<string> |
intent.not |
|
isAdjunctive |
boolean |
isAdjunctive.exists |
boolean |
isAdjunctive.not.exists |
boolean |
medications.createdAt.after |
string(date) |
medications.createdAt.before |
string(date) |
medications.createdAt.between |
Array<> |
medications.createdAt.exists |
boolean |
medications.createdAt.not.between |
Array<> |
medications.createdAt.not.exists |
boolean |
medications.createdAt.not.on |
string(date) |
medications.createdAt.on |
string(date) |
medications.createdAt.onOrAfter |
string(date) |
medications.createdAt.onOrBefore |
string(date) |
medications.dosageMass.between |
Array<> |
medications.dosageMass.equal |
number |
medications.dosageMass.exists |
boolean |
medications.dosageMass.greaterThan |
number |
medications.dosageMass.greaterThanOrEqual |
number |
medications.dosageMass.lessThan |
number |
medications.dosageMass.lessThanOrEqual |
number |
medications.dosageMass.not.between |
Array<> |
medications.dosageMass.not.equal |
number |
medications.dosageMass.not.exists |
boolean |
medications.dosageMassConcentration.between |
Array<> |
medications.dosageMassConcentration.equal |
number |
medications.dosageMassConcentration.exists |
boolean |
medications.dosageMassConcentration.greaterThan |
number |
medications.dosageMassConcentration.greaterThanOrEqual |
number |
medications.dosageMassConcentration.lessThan |
number |
medications.dosageMassConcentration.lessThanOrEqual |
number |
medications.dosageMassConcentration.not.between |
Array<> |
medications.dosageMassConcentration.not.equal |
number |
medications.dosageMassConcentration.not.exists |
boolean |
medications.dosageMassSurface.between |
Array<> |
medications.dosageMassSurface.equal |
number |
medications.dosageMassSurface.exists |
boolean |
medications.dosageMassSurface.greaterThan |
number |
medications.dosageMassSurface.greaterThanOrEqual |
number |
medications.dosageMassSurface.lessThan |
number |
medications.dosageMassSurface.lessThanOrEqual |
number |
medications.dosageMassSurface.not.between |
Array<> |
medications.dosageMassSurface.not.equal |
number |
medications.dosageMassSurface.not.exists |
boolean |
medications.dosageRateMass.between |
Array<> |
medications.dosageRateMass.equal |
number |
medications.dosageRateMass.exists |
boolean |
medications.dosageRateMass.greaterThan |
number |
medications.dosageRateMass.greaterThanOrEqual |
number |
medications.dosageRateMass.lessThan |
number |
medications.dosageRateMass.lessThanOrEqual |
number |
medications.dosageRateMass.not.between |
Array<> |
medications.dosageRateMass.not.equal |
number |
medications.dosageRateMass.not.exists |
boolean |
medications.dosageRateMassConcentration.between |
Array<> |
medications.dosageRateMassConcentration.equal |
number |
medications.dosageRateMassConcentration.exists |
boolean |
medications.dosageRateMassConcentration.greaterThan |
number |
medications.dosageRateMassConcentration.greaterThanOrEqual |
number |
medications.dosageRateMassConcentration.lessThan |
number |
medications.dosageRateMassConcentration.lessThanOrEqual |
number |
medications.dosageRateMassConcentration.not.between |
Array<> |
medications.dosageRateMassConcentration.not.equal |
number |
medications.dosageRateMassConcentration.not.exists |
boolean |
medications.dosageRateMassSurface.between |
Array<> |
medications.dosageRateMassSurface.equal |
number |
medications.dosageRateMassSurface.exists |
boolean |
medications.dosageRateMassSurface.greaterThan |
number |
medications.dosageRateMassSurface.greaterThanOrEqual |
number |
medications.dosageRateMassSurface.lessThan |
number |
medications.dosageRateMassSurface.lessThanOrEqual |
number |
medications.dosageRateMassSurface.not.between |
Array<> |
medications.dosageRateMassSurface.not.equal |
number |
medications.dosageRateMassSurface.not.exists |
boolean |
medications.dosageRateVolume.between |
Array<> |
medications.dosageRateVolume.equal |
number |
medications.dosageRateVolume.exists |
boolean |
medications.dosageRateVolume.greaterThan |
number |
medications.dosageRateVolume.greaterThanOrEqual |
number |
medications.dosageRateVolume.lessThan |
number |
medications.dosageRateVolume.lessThanOrEqual |
number |
medications.dosageRateVolume.not.between |
Array<> |
medications.dosageRateVolume.not.equal |
number |
medications.dosageRateVolume.not.exists |
boolean |
medications.dosageVolume.between |
Array<> |
medications.dosageVolume.equal |
number |
medications.dosageVolume.exists |
boolean |
medications.dosageVolume.greaterThan |
number |
medications.dosageVolume.greaterThanOrEqual |
number |
medications.dosageVolume.lessThan |
number |
medications.dosageVolume.lessThanOrEqual |
number |
medications.dosageVolume.not.between |
Array<> |
medications.dosageVolume.not.equal |
number |
medications.dosageVolume.not.exists |
boolean |
medications.drug |
string |
medications.drug.anyOf |
Array<string> |
medications.drug.descendantsOf |
string |
medications.drug.not |
string |
medications.drug.not.anyOf |
Array<string> |
medications.externalSource |
string |
medications.externalSource.anyOf |
Array<string> |
medications.externalSource.beginsWith |
string |
medications.externalSource.contains |
string |
medications.externalSource.endsWith |
string |
medications.externalSource.exists |
boolean |
medications.externalSource.not |
string |
medications.externalSource.not.anyOf |
Array<string> |
medications.externalSource.not.beginsWith |
string |
medications.externalSource.not.contains |
string |
medications.externalSource.not.endsWith |
string |
medications.externalSource.not.exists |
boolean |
medications.id |
string |
medications.id.anyOf |
Array<string> |
medications.id.beginsWith |
string |
medications.id.contains |
string |
medications.id.endsWith |
string |
medications.id.not |
string |
medications.id.not.anyOf |
Array<string> |
medications.id.not.beginsWith |
string |
medications.id.not.contains |
string |
medications.id.not.endsWith |
string |
medications.route |
string |
medications.route.anyOf |
Array<string> |
medications.route.descendantsOf |
string |
medications.route.exists |
boolean |
medications.route.not |
string |
medications.route.not.anyOf |
Array<string> |
medications.route.not.exists |
boolean |
medications.updatedAt.after |
string(date) |
medications.updatedAt.before |
string(date) |
medications.updatedAt.between |
Array<> |
medications.updatedAt.exists |
boolean |
medications.updatedAt.not.between |
Array<> |
medications.updatedAt.not.exists |
boolean |
medications.updatedAt.not.on |
string(date) |
medications.updatedAt.on |
string(date) |
medications.updatedAt.onOrAfter |
string(date) |
medications.updatedAt.onOrBefore |
string(date) |
medications.usedOfflabel |
boolean |
medications.usedOfflabel.exists |
boolean |
medications.usedOfflabel.not.exists |
boolean |
medications.withinSoc |
boolean |
medications.withinSoc.exists |
boolean |
medications.withinSoc.not.exists |
boolean |
period.containedBy |
Array<> |
period.contains |
Array<> |
period.not.containedBy |
Array<> |
period.not.contains |
Array<> |
period.not.overlaps |
Array<> |
period.overlaps |
Array<> |
targetedEntitiesIds |
string |
targetedEntitiesIds.anyOf |
Array<string> |
targetedEntitiesIds.beginsWith |
string |
targetedEntitiesIds.contains |
string |
targetedEntitiesIds.endsWith |
string |
targetedEntitiesIds.not |
string |
targetedEntitiesIds.not.anyOf |
Array<string> |
targetedEntitiesIds.not.beginsWith |
string |
targetedEntitiesIds.not.contains |
string |
targetedEntitiesIds.not.endsWith |
string |
terminationReason |
string |
terminationReason.anyOf |
Array<string> |
terminationReason.descendantsOf |
string |
terminationReason.exists |
boolean |
terminationReason.not |
string |
terminationReason.not.anyOf |
Array<string> |
terminationReason.not.exists |
boolean |
therapyLineId |
string |
therapyLineId.anyOf |
Array<string> |
therapyLineId.beginsWith |
string |
therapyLineId.contains |
string |
therapyLineId.endsWith |
string |
therapyLineId.exists |
boolean |
therapyLineId.not |
string |
therapyLineId.not.anyOf |
Array<string> |
therapyLineId.not.beginsWith |
string |
therapyLineId.not.contains |
string |
therapyLineId.not.endsWith |
string |
therapyLineId.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
SystemicTherapyIntentChoices¶
Type: string
SystemicTherapyMedication¶
| Name | Type |
|---|---|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
dosageMass |
|
dosageMassConcentration |
|
dosageMassSurface |
|
dosageRateMass |
|
dosageRateMassConcentration |
|
dosageRateMassSurface |
|
dosageRateVolume |
|
dosageVolume |
|
drug |
CodedConcept |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
route |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
usedOfflabel |
boolean |
withinSoc |
boolean |
SystemicTherapyMedicationCreate¶
| Name | Type |
|---|---|
dosageMass |
|
dosageMassConcentration |
|
dosageMassSurface |
|
dosageRateMass |
|
dosageRateMassConcentration |
|
dosageRateMassSurface |
|
dosageRateVolume |
|
dosageVolume |
|
drug |
CodedConcept |
externalSource |
string |
externalSourceId |
string |
route |
|
usedOfflabel |
boolean |
withinSoc |
boolean |
SystemicTherapyMedicationPartial¶
| Name | Type |
|---|---|
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
dosageMass |
|
dosageMassConcentration |
|
dosageMassSurface |
|
dosageRateMass |
|
dosageRateMassConcentration |
|
dosageRateMassSurface |
|
dosageRateVolume |
|
dosageVolume |
|
drug |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
route |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
usedOfflabel |
boolean |
withinSoc |
boolean |
SystemicTherapyPartial¶
| Name | Type |
|---|---|
adjunctiveRole |
|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
cycles |
integer |
description |
string |
duration |
|
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
intent |
|
isAdjunctive |
boolean |
medications |
Array<SystemicTherapyMedicationPartial> |
period |
string |
targetedEntitiesIds |
Array<string(uuid)> |
terminationReason |
|
therapyLineId |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
TerminologyFilters¶
| Name | Type |
|---|---|
codes |
|
query |
TherapyLine¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
intent |
TherapyLineIntentChoices |
label |
string |
ordinal |
integer |
period |
|
progressionDate |
string(date) |
progressionFreeSurvival |
number |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
TherapyLineCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
externalSource |
string |
externalSourceId |
string |
intent |
TherapyLineIntentChoices |
ordinal |
integer |
progressionDate |
string(date) |
TherapyLineFilters¶
| Name | Type |
|---|---|
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
intent |
|
intent.anyOf |
Array<string> |
intent.not |
|
label |
string |
label.anyOf |
Array<string> |
label.beginsWith |
string |
label.contains |
string |
label.endsWith |
string |
label.not |
string |
label.not.anyOf |
Array<string> |
label.not.beginsWith |
string |
label.not.contains |
string |
label.not.endsWith |
string |
ordinal.between |
Array<> |
ordinal.equal |
integer |
ordinal.greaterThan |
integer |
ordinal.greaterThanOrEqual |
integer |
ordinal.lessThan |
integer |
ordinal.lessThanOrEqual |
integer |
ordinal.not.between |
Array<> |
ordinal.not.equal |
integer |
period.containedBy |
Array<> |
period.contains |
Array<> |
period.exists |
boolean |
period.not.containedBy |
Array<> |
period.not.contains |
Array<> |
period.not.exists |
boolean |
period.not.overlaps |
Array<> |
period.overlaps |
Array<> |
progressionDate.after |
string(date) |
progressionDate.before |
string(date) |
progressionDate.between |
Array<> |
progressionDate.exists |
boolean |
progressionDate.not.between |
Array<> |
progressionDate.not.exists |
boolean |
progressionDate.not.on |
string(date) |
progressionDate.on |
string(date) |
progressionDate.onOrAfter |
string(date) |
progressionDate.onOrBefore |
string(date) |
progressionFreeSurvival.between |
Array<> |
progressionFreeSurvival.equal |
number |
progressionFreeSurvival.exists |
boolean |
progressionFreeSurvival.greaterThan |
number |
progressionFreeSurvival.greaterThanOrEqual |
number |
progressionFreeSurvival.lessThan |
number |
progressionFreeSurvival.lessThanOrEqual |
number |
progressionFreeSurvival.not.between |
Array<> |
progressionFreeSurvival.not.equal |
number |
progressionFreeSurvival.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
TherapyLineIntentChoices¶
Type: string
TherapyLinePartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
intent |
|
label |
string |
ordinal |
integer |
period |
string |
progressionDate |
string(date) |
progressionFreeSurvival |
number |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
TNMStaging¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
distantmetastases |
|
externalSource |
string |
externalSourceId |
string |
grade |
|
id |
string(uuid) |
lymphaticinvasion |
|
methodology |
|
pathological |
boolean |
perineuralinvasion |
|
primarytumor |
|
regionalnodes |
|
residualtumor |
|
serumtumormarkerlevel |
|
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
venousinvasion |
TNMStagingCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
distantmetastases |
|
externalSource |
string |
externalSourceId |
string |
grade |
|
lymphaticinvasion |
|
methodology |
|
pathological |
boolean |
perineuralinvasion |
|
primarytumor |
|
regionalnodes |
|
residualtumor |
|
serumtumormarkerlevel |
|
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
venousinvasion |
TNMStagingPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
distantmetastases |
|
externalSource |
string |
externalSourceId |
string |
grade |
|
id |
string(uuid) |
lymphaticinvasion |
|
methodology |
|
pathological |
boolean |
perineuralinvasion |
|
primarytumor |
|
regionalnodes |
|
residualtumor |
|
serumtumormarkerlevel |
|
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
venousinvasion |
TreatmentResponse¶
| Name | Type |
|---|---|
anonymized |
boolean |
assessedBodysites |
Array<CodedConcept> |
assessedEntitiesIds |
Array<string(uuid)> |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
CodedConcept |
recist |
CodedConcept |
recistInterpreted |
boolean |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
TreatmentResponseCreate¶
| Name | Type |
|---|---|
assessedBodysites |
Array<CodedConcept> |
assessedEntitiesIds |
Array<string(uuid)> |
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
methodology |
CodedConcept |
recist |
CodedConcept |
recistInterpreted |
boolean |
TreatmentResponseFilters¶
| Name | Type |
|---|---|
assessedBodysites |
string |
assessedBodysites.allOf |
Array<string> |
assessedBodysites.anyOf |
Array<string> |
assessedBodysites.descendantsOf |
string |
assessedBodysites.exists |
boolean |
assessedBodysites.not |
string |
assessedBodysites.not.allOf |
Array<string> |
assessedBodysites.not.anyOf |
Array<string> |
assessedBodysites.not.exists |
boolean |
assessedEntitiesIds |
string |
assessedEntitiesIds.anyOf |
Array<string> |
assessedEntitiesIds.beginsWith |
string |
assessedEntitiesIds.contains |
string |
assessedEntitiesIds.endsWith |
string |
assessedEntitiesIds.not |
string |
assessedEntitiesIds.not.anyOf |
Array<string> |
assessedEntitiesIds.not.beginsWith |
string |
assessedEntitiesIds.not.contains |
string |
assessedEntitiesIds.not.endsWith |
string |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
methodology |
string |
methodology.anyOf |
Array<string> |
methodology.descendantsOf |
string |
methodology.not |
string |
methodology.not.anyOf |
Array<string> |
recist |
string |
recist.anyOf |
Array<string> |
recist.descendantsOf |
string |
recist.not |
string |
recist.not.anyOf |
Array<string> |
recistInterpreted |
boolean |
recistInterpreted.exists |
boolean |
recistInterpreted.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
TreatmentResponsePartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
assessedBodysites |
|
assessedEntitiesIds |
Array<string(uuid)> |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
methodology |
|
recist |
|
recistInterpreted |
boolean |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
TumorBoardFilters¶
| Name | Type |
|---|---|
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
recommendations |
string |
recommendations.allOf |
Array<string> |
recommendations.anyOf |
Array<string> |
recommendations.descendantsOf |
string |
recommendations.exists |
boolean |
recommendations.not |
string |
recommendations.not.allOf |
Array<string> |
recommendations.not.anyOf |
Array<string> |
recommendations.not.exists |
boolean |
relatedEntitiesIds |
string |
relatedEntitiesIds.anyOf |
Array<string> |
relatedEntitiesIds.beginsWith |
string |
relatedEntitiesIds.contains |
string |
relatedEntitiesIds.endsWith |
string |
relatedEntitiesIds.not |
string |
relatedEntitiesIds.not.anyOf |
Array<string> |
relatedEntitiesIds.not.beginsWith |
string |
relatedEntitiesIds.not.contains |
string |
relatedEntitiesIds.not.endsWith |
string |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
TumorMarker¶
| Name | Type |
|---|---|
analyte |
CodedConcept |
anonymized |
boolean |
arbitraryConcentration |
|
caseId |
string(uuid) |
combinedPositiveScore |
|
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
fraction |
|
id |
string(uuid) |
immuneCellScore |
|
immunohistochemicalScore |
|
massConcentration |
|
multipleOfMedian |
|
nuclearExpressionStatus |
|
presence |
|
relatedEntitiesIds |
Array<string(uuid)> |
substanceConcentration |
|
tumorProportionScore |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
TumorMarkerCreate¶
| Name | Type |
|---|---|
analyte |
CodedConcept |
arbitraryConcentration |
|
caseId |
string(uuid) |
combinedPositiveScore |
|
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
fraction |
|
immuneCellScore |
|
immunohistochemicalScore |
|
massConcentration |
|
multipleOfMedian |
|
nuclearExpressionStatus |
|
presence |
|
relatedEntitiesIds |
Array<string(uuid)> |
substanceConcentration |
|
tumorProportionScore |
TumorMarkerFilters¶
| Name | Type |
|---|---|
analyte |
string |
analyte.anyOf |
Array<string> |
analyte.descendantsOf |
string |
analyte.not |
string |
analyte.not.anyOf |
Array<string> |
arbitraryConcentration.between |
Array<> |
arbitraryConcentration.equal |
number |
arbitraryConcentration.exists |
boolean |
arbitraryConcentration.greaterThan |
number |
arbitraryConcentration.greaterThanOrEqual |
number |
arbitraryConcentration.lessThan |
number |
arbitraryConcentration.lessThanOrEqual |
number |
arbitraryConcentration.not.between |
Array<> |
arbitraryConcentration.not.equal |
number |
arbitraryConcentration.not.exists |
boolean |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
combinedPositiveScore.between |
Array<> |
combinedPositiveScore.equal |
number |
combinedPositiveScore.exists |
boolean |
combinedPositiveScore.greaterThan |
number |
combinedPositiveScore.greaterThanOrEqual |
number |
combinedPositiveScore.lessThan |
number |
combinedPositiveScore.lessThanOrEqual |
number |
combinedPositiveScore.not.between |
Array<> |
combinedPositiveScore.not.equal |
number |
combinedPositiveScore.not.exists |
boolean |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
fraction.between |
Array<> |
fraction.equal |
number |
fraction.exists |
boolean |
fraction.greaterThan |
number |
fraction.greaterThanOrEqual |
number |
fraction.lessThan |
number |
fraction.lessThanOrEqual |
number |
fraction.not.between |
Array<> |
fraction.not.equal |
number |
fraction.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
immuneCellScore |
|
immuneCellScore.anyOf |
Array<string> |
immuneCellScore.exists |
boolean |
immuneCellScore.not |
|
immuneCellScore.not.exists |
boolean |
immunohistochemicalScore |
|
immunohistochemicalScore.anyOf |
Array<string> |
immunohistochemicalScore.exists |
boolean |
immunohistochemicalScore.not |
|
immunohistochemicalScore.not.exists |
boolean |
massConcentration.between |
Array<> |
massConcentration.equal |
number |
massConcentration.exists |
boolean |
massConcentration.greaterThan |
number |
massConcentration.greaterThanOrEqual |
number |
massConcentration.lessThan |
number |
massConcentration.lessThanOrEqual |
number |
massConcentration.not.between |
Array<> |
massConcentration.not.equal |
number |
massConcentration.not.exists |
boolean |
multipleOfMedian.between |
Array<> |
multipleOfMedian.equal |
number |
multipleOfMedian.exists |
boolean |
multipleOfMedian.greaterThan |
number |
multipleOfMedian.greaterThanOrEqual |
number |
multipleOfMedian.lessThan |
number |
multipleOfMedian.lessThanOrEqual |
number |
multipleOfMedian.not.between |
Array<> |
multipleOfMedian.not.equal |
number |
multipleOfMedian.not.exists |
boolean |
nuclearExpressionStatus |
|
nuclearExpressionStatus.anyOf |
Array<string> |
nuclearExpressionStatus.exists |
boolean |
nuclearExpressionStatus.not |
|
nuclearExpressionStatus.not.exists |
boolean |
presence |
|
presence.anyOf |
Array<string> |
presence.exists |
boolean |
presence.not |
|
presence.not.exists |
boolean |
relatedEntitiesIds |
string |
relatedEntitiesIds.anyOf |
Array<string> |
relatedEntitiesIds.beginsWith |
string |
relatedEntitiesIds.contains |
string |
relatedEntitiesIds.endsWith |
string |
relatedEntitiesIds.not |
string |
relatedEntitiesIds.not.anyOf |
Array<string> |
relatedEntitiesIds.not.beginsWith |
string |
relatedEntitiesIds.not.contains |
string |
relatedEntitiesIds.not.endsWith |
string |
substanceConcentration.between |
Array<> |
substanceConcentration.equal |
number |
substanceConcentration.exists |
boolean |
substanceConcentration.greaterThan |
number |
substanceConcentration.greaterThanOrEqual |
number |
substanceConcentration.lessThan |
number |
substanceConcentration.lessThanOrEqual |
number |
substanceConcentration.not.between |
Array<> |
substanceConcentration.not.equal |
number |
substanceConcentration.not.exists |
boolean |
tumorProportionScore |
|
tumorProportionScore.anyOf |
Array<string> |
tumorProportionScore.exists |
boolean |
tumorProportionScore.not |
|
tumorProportionScore.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
TumorMarkerImmuneCellScoreChoices¶
Type: string
TumorMarkerImmunohistochemicalScoreChoices¶
Type: string
TumorMarkerNuclearExpressionStatusChoices¶
Type: string
TumorMarkerPartial¶
| Name | Type |
|---|---|
analyte |
|
anonymized |
boolean |
arbitraryConcentration |
|
caseId |
string(uuid) |
combinedPositiveScore |
|
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
fraction |
|
id |
string(uuid) |
immuneCellScore |
|
immunohistochemicalScore |
|
massConcentration |
|
multipleOfMedian |
|
nuclearExpressionStatus |
|
presence |
|
relatedEntitiesIds |
Array<string(uuid)> |
substanceConcentration |
|
tumorProportionScore |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
TumorMarkerPresenceChoices¶
Type: string
TumorMarkerTumorProportionScoreChoices¶
Type: string
TumorMutationalBurden¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
status |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
number |
TumorMutationalBurdenCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
category |
string |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
status |
|
value |
number |
TumorMutationalBurdenPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
status |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
number |
TumorMutationalBurdenStatusChoices¶
Type: string
TumorNeoantigenBurden¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
number |
TumorNeoantigenBurdenCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
category |
string |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
value |
number |
TumorNeoantigenBurdenPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
value |
number |
UnspecifiedTumorBoard¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
recommendations |
Array<CodedConcept> |
relatedEntitiesIds |
Array<string(uuid)> |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
UnspecifiedTumorBoardCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
category |
string |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
recommendations |
Array<CodedConcept> |
relatedEntitiesIds |
Array<string(uuid)> |
UnspecifiedTumorBoardPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
category |
string |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
recommendations |
|
relatedEntitiesIds |
Array<string(uuid)> |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
User¶
| Name | Type |
|---|---|
accessLevel |
integer |
canExportData |
boolean |
canManageCases |
boolean |
canManageProjects |
boolean |
canManageUsers |
boolean |
canViewCases |
boolean |
canViewCohorts |
boolean |
canViewDatasets |
boolean |
canViewProjects |
boolean |
canViewUsers |
boolean |
department |
string |
email |
string |
firstName |
string |
fullName |
string |
id |
string(uuid) |
isActive |
boolean |
isProvided |
boolean |
isServiceAccount |
boolean |
isSystemAdmin |
boolean |
lastLogin |
string(date-time) |
lastName |
string |
organization |
string |
provider |
string |
role |
AccessRoles |
shareable |
boolean |
title |
string |
username |
string |
UserCreate¶
| Name | Type |
|---|---|
accessLevel |
integer |
department |
string |
email |
string |
firstName |
string |
isActive |
boolean |
isServiceAccount |
boolean |
lastLogin |
string(date-time) |
lastName |
string |
organization |
string |
shareable |
boolean |
title |
string |
username |
string |
UserCredentials¶
| Name | Type |
|---|---|
password |
string |
username |
string |
UserFilters¶
| Name | Type |
|---|---|
accessLevel.between |
Array<> |
accessLevel.equal |
integer |
accessLevel.greaterThan |
integer |
accessLevel.greaterThanOrEqual |
integer |
accessLevel.lessThan |
integer |
accessLevel.lessThanOrEqual |
integer |
accessLevel.not.between |
Array<> |
accessLevel.not.equal |
integer |
canExportData |
boolean |
canManageCases |
boolean |
canManageProjects |
boolean |
canManageUsers |
boolean |
canViewCases |
boolean |
canViewCohorts |
boolean |
canViewDatasets |
boolean |
canViewProjects |
boolean |
canViewUsers |
boolean |
department |
string |
department.anyOf |
Array<string> |
department.beginsWith |
string |
department.contains |
string |
department.endsWith |
string |
department.exists |
boolean |
department.not |
string |
department.not.anyOf |
Array<string> |
department.not.beginsWith |
string |
department.not.contains |
string |
department.not.endsWith |
string |
department.not.exists |
boolean |
email |
string |
email.anyOf |
Array<string> |
email.beginsWith |
string |
email.contains |
string |
email.endsWith |
string |
email.exists |
boolean |
email.not |
string |
email.not.anyOf |
Array<string> |
email.not.beginsWith |
string |
email.not.contains |
string |
email.not.endsWith |
string |
email.not.exists |
boolean |
firstName |
string |
firstName.anyOf |
Array<string> |
firstName.beginsWith |
string |
firstName.contains |
string |
firstName.endsWith |
string |
firstName.exists |
boolean |
firstName.not |
string |
firstName.not.anyOf |
Array<string> |
firstName.not.beginsWith |
string |
firstName.not.contains |
string |
firstName.not.endsWith |
string |
firstName.not.exists |
boolean |
fullName |
string |
fullName.anyOf |
Array<string> |
fullName.beginsWith |
string |
fullName.contains |
string |
fullName.endsWith |
string |
fullName.not |
string |
fullName.not.anyOf |
Array<string> |
fullName.not.beginsWith |
string |
fullName.not.contains |
string |
fullName.not.endsWith |
string |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
isActive |
boolean |
isProvided |
boolean |
isServiceAccount |
boolean |
isSystemAdmin |
boolean |
lastLogin.after |
string(date) |
lastLogin.before |
string(date) |
lastLogin.between |
Array<> |
lastLogin.exists |
boolean |
lastLogin.not.between |
Array<> |
lastLogin.not.exists |
boolean |
lastLogin.not.on |
string(date) |
lastLogin.on |
string(date) |
lastLogin.onOrAfter |
string(date) |
lastLogin.onOrBefore |
string(date) |
lastName |
string |
lastName.anyOf |
Array<string> |
lastName.beginsWith |
string |
lastName.contains |
string |
lastName.endsWith |
string |
lastName.exists |
boolean |
lastName.not |
string |
lastName.not.anyOf |
Array<string> |
lastName.not.beginsWith |
string |
lastName.not.contains |
string |
lastName.not.endsWith |
string |
lastName.not.exists |
boolean |
organization |
string |
organization.anyOf |
Array<string> |
organization.beginsWith |
string |
organization.contains |
string |
organization.endsWith |
string |
organization.exists |
boolean |
organization.not |
string |
organization.not.anyOf |
Array<string> |
organization.not.beginsWith |
string |
organization.not.contains |
string |
organization.not.endsWith |
string |
organization.not.exists |
boolean |
provider |
string |
provider.anyOf |
Array<string> |
provider.beginsWith |
string |
provider.contains |
string |
provider.endsWith |
string |
provider.exists |
boolean |
provider.not |
string |
provider.not.anyOf |
Array<string> |
provider.not.beginsWith |
string |
provider.not.contains |
string |
provider.not.endsWith |
string |
provider.not.exists |
boolean |
role |
|
role.anyOf |
Array<string> |
role.not |
|
shareable |
boolean |
shareable.exists |
boolean |
shareable.not.exists |
boolean |
title |
string |
title.anyOf |
Array<string> |
title.beginsWith |
string |
title.contains |
string |
title.endsWith |
string |
title.exists |
boolean |
title.not |
string |
title.not.anyOf |
Array<string> |
title.not.beginsWith |
string |
title.not.contains |
string |
title.not.endsWith |
string |
title.not.exists |
boolean |
username |
string |
username.anyOf |
Array<string> |
username.beginsWith |
string |
username.contains |
string |
username.endsWith |
string |
username.not |
string |
username.not.anyOf |
Array<string> |
username.not.beginsWith |
string |
username.not.contains |
string |
username.not.endsWith |
string |
UserPasswordReset¶
| Name | Type |
|---|---|
newPassword |
string |
oldPassword |
string |
UserProfileSchema¶
| Name | Type |
|---|---|
department |
string |
email |
string |
firstName |
string |
lastName |
string |
organization |
string |
title |
string |
UserProviderClientToken¶
| Name | Type |
|---|---|
access_token |
string |
client_id |
string |
id_token |
string |
UserProviderToken¶
| Name | Type |
|---|---|
process |
|
provider |
string |
token |
UserProviderClientToken |
Vitals¶
| Name | Type |
|---|---|
anonymized |
boolean |
bloodPressureDiastolic |
|
bloodPressureSystolic |
|
bodyMassIndex |
|
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
height |
|
id |
string(uuid) |
temperature |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
weight |
VitalsCreate¶
| Name | Type |
|---|---|
bloodPressureDiastolic |
|
bloodPressureSystolic |
|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
height |
|
temperature |
|
weight |
VitalsFilters¶
| Name | Type |
|---|---|
bloodPressureDiastolic.between |
Array<> |
bloodPressureDiastolic.equal |
number |
bloodPressureDiastolic.exists |
boolean |
bloodPressureDiastolic.greaterThan |
number |
bloodPressureDiastolic.greaterThanOrEqual |
number |
bloodPressureDiastolic.lessThan |
number |
bloodPressureDiastolic.lessThanOrEqual |
number |
bloodPressureDiastolic.not.between |
Array<> |
bloodPressureDiastolic.not.equal |
number |
bloodPressureDiastolic.not.exists |
boolean |
bloodPressureSystolic.between |
Array<> |
bloodPressureSystolic.equal |
number |
bloodPressureSystolic.exists |
boolean |
bloodPressureSystolic.greaterThan |
number |
bloodPressureSystolic.greaterThanOrEqual |
number |
bloodPressureSystolic.lessThan |
number |
bloodPressureSystolic.lessThanOrEqual |
number |
bloodPressureSystolic.not.between |
Array<> |
bloodPressureSystolic.not.equal |
number |
bloodPressureSystolic.not.exists |
boolean |
bodyMassIndex.between |
Array<> |
bodyMassIndex.equal |
number |
bodyMassIndex.exists |
boolean |
bodyMassIndex.greaterThan |
number |
bodyMassIndex.greaterThanOrEqual |
number |
bodyMassIndex.lessThan |
number |
bodyMassIndex.lessThanOrEqual |
number |
bodyMassIndex.not.between |
Array<> |
bodyMassIndex.not.equal |
number |
bodyMassIndex.not.exists |
boolean |
caseId |
string |
caseId.anyOf |
Array<string> |
caseId.beginsWith |
string |
caseId.contains |
string |
caseId.endsWith |
string |
caseId.not |
string |
caseId.not.anyOf |
Array<string> |
caseId.not.beginsWith |
string |
caseId.not.contains |
string |
caseId.not.endsWith |
string |
createdAt.after |
string(date) |
createdAt.before |
string(date) |
createdAt.between |
Array<> |
createdAt.exists |
boolean |
createdAt.not.between |
Array<> |
createdAt.not.exists |
boolean |
createdAt.not.on |
string(date) |
createdAt.on |
string(date) |
createdAt.onOrAfter |
string(date) |
createdAt.onOrBefore |
string(date) |
date.after |
string(date) |
date.before |
string(date) |
date.between |
Array<> |
date.not.between |
Array<> |
date.not.on |
string(date) |
date.on |
string(date) |
date.onOrAfter |
string(date) |
date.onOrBefore |
string(date) |
externalSource |
string |
externalSource.anyOf |
Array<string> |
externalSource.beginsWith |
string |
externalSource.contains |
string |
externalSource.endsWith |
string |
externalSource.exists |
boolean |
externalSource.not |
string |
externalSource.not.anyOf |
Array<string> |
externalSource.not.beginsWith |
string |
externalSource.not.contains |
string |
externalSource.not.endsWith |
string |
externalSource.not.exists |
boolean |
height.between |
Array<> |
height.equal |
number |
height.exists |
boolean |
height.greaterThan |
number |
height.greaterThanOrEqual |
number |
height.lessThan |
number |
height.lessThanOrEqual |
number |
height.not.between |
Array<> |
height.not.equal |
number |
height.not.exists |
boolean |
id |
string |
id.anyOf |
Array<string> |
id.beginsWith |
string |
id.contains |
string |
id.endsWith |
string |
id.not |
string |
id.not.anyOf |
Array<string> |
id.not.beginsWith |
string |
id.not.contains |
string |
id.not.endsWith |
string |
temperature.between |
Array<> |
temperature.equal |
number |
temperature.exists |
boolean |
temperature.greaterThan |
number |
temperature.greaterThanOrEqual |
number |
temperature.lessThan |
number |
temperature.lessThanOrEqual |
number |
temperature.not.between |
Array<> |
temperature.not.equal |
number |
temperature.not.exists |
boolean |
updatedAt.after |
string(date) |
updatedAt.before |
string(date) |
updatedAt.between |
Array<> |
updatedAt.exists |
boolean |
updatedAt.not.between |
Array<> |
updatedAt.not.exists |
boolean |
updatedAt.not.on |
string(date) |
updatedAt.on |
string(date) |
updatedAt.onOrAfter |
string(date) |
updatedAt.onOrBefore |
string(date) |
weight.between |
Array<> |
weight.equal |
number |
weight.exists |
boolean |
weight.greaterThan |
number |
weight.greaterThanOrEqual |
number |
weight.lessThan |
number |
weight.lessThanOrEqual |
number |
weight.not.between |
Array<> |
weight.not.equal |
number |
weight.not.exists |
boolean |
VitalsPartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
bloodPressureDiastolic |
|
bloodPressureSystolic |
|
bodyMassIndex |
|
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
height |
|
id |
string(uuid) |
temperature |
|
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
weight |
WilmsStage¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
WilmsStageCreate¶
| Name | Type |
|---|---|
caseId |
string(uuid) |
date |
string(date) |
externalSource |
string |
externalSourceId |
string |
stage |
CodedConcept |
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
WilmsStagePartial¶
| Name | Type |
|---|---|
anonymized |
boolean |
caseId |
string(uuid) |
createdAt |
string(date-time) |
createdBy |
string |
date |
string(date) |
description |
string |
externalSource |
string |
externalSourceId |
string |
id |
string(uuid) |
stage |
|
stagedEntitiesIds |
Array<string(uuid)> |
stagingDomain |
string |
updatedAt |
string(date-time) |
updatedBy |
Array<string> |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| XSessionTokenAuth | apiKey |
Luis Fábregas-Ibáñez